StyleCop(C#代码检测工具)

Posted 2020-11-20 liangqihui

一、StyleCop是微软的一个开源的静态代码分析工具,检查c#代码一致性和编码风格。

二、下载地址   http://stylecop.codeplex.com/releases/view/79972

　　默认安装目录：C:Program Files (x86)StyleCop 4.7

　　自己定义的dll规则也放在这个目录下

三、使用方式：打开VS之后选择一个类或者一个类库右击

RunStyleCop运行结果：

四：编写自己的规则：

1、创建一个类库，

　　新建一个MyCustomAnalyzer.cs文件，引用StyleCop.dll和StyleCop.Csharp.dll

　　代码如下：

AddViolation方法中的三个参数"AvoidUsingAInClassNames"是自己定义的规则,这个规则就是下文xml中的 Rule Name="AvoidUsingAInClassNames"

2、新建一个和类同名的xml文件

　　MyCustomAnalyzer.xml内容如下：

　　设置该xml文件属性：编译方式为嵌入式 （即编译到dll中）,Rules中可以放多个Rule但不要忘了改Name和Id

 3、保存并编译

　　将这个项目生成DLL，把MyCustomAnalyzer.dll放到StyleCop根目录下。到此自定义规则就完成了。

4、使用自己的规则：

　　打开VS之后选择一个类或者一个类库右击，选择 StyleCop Settings设置规则，这里可以看到自己新添的规则。