使用StyleCop进行代码审查

1.简介

今天简单介绍下怎样使用StyleCop对原代码进行审查，看编写的代码是否遵循设计规范、.Net约定和一些贯用法等，保证代码的一致性，可读性等等，StyleCop    是用来检查代码是否符合设计规范的，它是基于原代码验证的，仅支持C#语言，就是在开发期间进行代码验证的工具，相信在日常开发中，会帮助到大家，在使用工具的同时，逐渐改善和提高大家的编码规范和意识

2.下载，安装

   首先下载最新版的StyleCop，下载地址：http://stylecop.codeplex.com/

   当前最新版本是StyleCop-4.7.37.0.msi，版本4.7，下载完成后，开始安装，安装过程非常简单,一路next，注意要先关闭vs

   安装好后，在项目上右键会出现下面的菜单

   在vs打开的文件邮件会多出如下菜单

运行run stylecop，错误列表中会出现警告，警告只能手动修改

3.设置，stylecop settings

4.常见的警告简单说明

SA1507 : CSharp.Layout : The code must not contain multiple blank lines in a row.

代码部分存在多个空格

 

SA1600 : CSharp.Documentation : The method must have a documentation header.

方法必须要头部说明，只要在方法前键入3个斜杠，IDE自动会根据该方法生成相关头文档说明

 

SA1400 : CSharp.Maintainability : The class must have an access modifier.

类必须要有一个访问修饰符，如：public、private等

 

SA1513 : CSharp.Layout : Statements or elements wrapped in curly brackets must be followed by a blank line.

语句之间要有空行

 

SA1202 : CSharp.Ordering : All private methods must be placed after all public methods.

私有方法要放在公有方法子后

 

SA1650 : CSharp.Documentation : The documentation text within the summary tag contains incorrectly spelled words: 异常测试

这个是对中文支持的不够好。拼写检查识别不到

其他还有常见的变量首字母小，常量首字母大写，等等常规检查，其它规则请参见StyleCop使用说明

5.和reshaper组合使用

reshaper有自己的代码审查，stylecop也有自己的代码审查，

reshaper的代码审查主要通过提示和 code cleanup体现

可以通过edit profiles 来设置新的代码审查规则，当你同时安装了reshaper和stylecop时，新建规则中会多出如下图的选项

这也是两者的结合处，只能手动的把两者结合起来配置成一个规则，然后，code cleanup 选中test规则名，clean一下，代码就符合你设定的规则啦

还有，安装了stylecop，reshaper会自动调用stylecop规则来验证是否符合其规则，若是不符合规则，则不符合stylecop规则的警告也会出现在错误列表中