[Tool] 使用StyleCop验证命名规则

[Tool] 使用StyleCop验证命名规则

前言

微软的MSDN上，有提供了一份微软的命名方针，指引开发人员去建立风格一致的程序代码。

• http://msdn.microsoft.com/zh-tw/library/vstudio/ms229002(v=vs.100).aspx

但是在项目开发的过程中，如果要透过人工检查的方式，去验证每行程序代码是否符合命名规则，这单纯只是考验忍耐上限的工作项目。本篇文章介绍如何透过StyleCop这个工具，来自动验证项目中的程序代码是否符合命名规则，在不增加开发人员负担的前提下，让团队的程序代码产出趋于一致、大幅提高生产的程序代码质量。主要为自己留个纪录，也希望能帮助到有需要的开发人员。

安装

1. 首先至StyleCop的官方网站，下载StyleCop安装档：「StyleCop-4.7.49.0.msi」。

   • http://stylecop.codeplex.com/

   

2. 执行StyleCop安装档：「StyleCop-4.7.49.0.msi」，来安装StyleCop。

   

执行

1. 使用Visual Studio开启项目。

   

2. 方案总管中选择项目、开启右键选单、点选StyleCop Settings来开启设定画面。

   

3. 保留Naming Rules、并移除其他规则后，点击OK按钮完成设定。(本篇文章单纯验证命名规则，其他规则可依项目需求自行加入。)

   

4. 方案总管中选择项目、开启右键选单、点选Run StyleCop来开始验证项目的命名规则。

   • 验证通过的显示结果为：

   

   • 验证失败的显示结果为：

   

延伸

在StyleCop默认的Naming Rules中，物件的Private field是套用「小写开头」的命名规则。

public class Class1
{
    // Fields
    private int count = 1;
}

但是个人是比较偏好，对象的Private field是套用「底线+小写开头」的命名规则。(加不加底线这个规则，开发团队讲好选择相同的Style即可)

public class Class1
{
    // Fields
    private int _count = 1;
}

为了将「Private field：底线+小写开头」这个命名规则，加入到项目的命名规则中。开发人员可以先点击下列连结来取得「CLK.StyleCop.Rules.dll」，并且将这个dll加入StyleCop的安装目录。(预设为C:\Program Files (x86)\StyleCop 4.7)

• http://Files.Dotblogs.com.tw/clark/1409/201492918326569.rar

接着在Visual Studio中，开启项目的StyleCop Settings，变更Naming Rules为下图设定。

完成上列设定步骤后，验证项目命名规则时，就会改为套用「Private field：底线+小写开头」这个命名规则。

参考数据

• 91 - [Tool]程序代码风格分析－StyleCop

• SCOTT - Creating Custom StyleCop Rules in C#