StyleCop(C#代码规范分析工具)---1.介绍,下载及配置

介绍

　　StyleCop 是项目级别，开源免费，静态分析C#代码规范的工具，具有功能强大，简单易用，配置灵活等特点。StyleCop中内置的代码规范是根据.Net Framework 框架的设计原则来制定的！当然，你也可以创建自己的规则！StyleCop包括两个版本，一个是GUI版，一个是命令行。最新的StyleCop已经自动集成到VS2010当中，方便应用。

规则包括以下类别:

• 文档(Documentation)
• 布局(Layout)
• 可维护性(Maintainability)
• 命名(Naming)
• 顺序(Ordering)
• 可读性(Readability)
• 间隔(Spacing)  

 

下载及配置

　　StyleCop主页是:http://stylecop.codeplex.com/,可以在DownLoad下载最新版，当前最新版是4.7.17.0。下载的是个MSI文件直接双击运行，安装成功后，重新打开VS2010，在项目中右击项目名称，发现多了两个选择项(Run StyleCop和StyleCop Settings)。如图:

 

Run StyleCop

　　会根据选择的规则,分析项目中的代码。如果你想分析某个文件或者某个文件夹下所有文件，可以直接在该文件或者文件夹上右击，在选择Run StyleCop即可。
分析完毕后会在 错误列表 中以警告的形式显示所有信息。

 

StyleCop Settings

　　可以设置需要的规则。选择StyleCop Settings,可以打开如下对话框：

根据自己项目的需要，选择合适的规则。