c#代码规范和质量检查工具这点事
代码风格检查:StyleCop
代码缺陷检查:FxCop
代码质量: 代码度量值/Code Metrics
StyleCop
介绍
The StyleCop tool provides warnings that indicate style and consistency rule violations in C# code. The warnings are organized into rule areas such as documentation, layout, naming, ordering, readability, spacing, and so forth. Each warning signifies a violation of a style or consistency rule.
安装
这个工具不是集成在VS中,需要单独安装
http://stylecop.codeplex.com/
不同的VS版本安装对应的即可
分析项的设置
设置检查的项:不检查的不选择即可
如一般的SA1200不选
Settings.StyleCop的优先顺序
项目目录下Settings.StyleCop设置项优先,然后合并安装目录下的Settings.StyleCop设置项
根据以上可知,在一个小组内应用一样的检查的步骤:
使用以上步骤设置检查的内容,可以在项目目录下看到Settings.StyleCop,将这个文件分发给所有人,覆盖安装目录下的C:Program FilesMicrosoft StyleCop ***下的这个文件即可
分析
项目上右键选择菜单“Run StyleCop”,可以看到分析结果
具体的分析问题解决方法:
在C:Program FilesMicrosoft StyleCop ***DocsStyleCop.chm文档的索引栏目输入SA*,可以查看原因和规范方法
FxCop
介绍
代码分析工具,帮助您检测和更正代码缺陷。
托管代码代码分析工具分析托管程序集并报告有关程序集的信息,例如 Microsoft .NET Framework 设计准则中规定的编程和设计规则的冲突。分析工具将它在分析期间执行的检查表示为警告。
本工具集成在VS中
设置和使用
Ø 分析中的错误信息如CA0001,直接在MSDN可以查到问题的描述和解决方法
Ø 由于分析的过程速度较慢,最好不要在DEBUG模式下设置“生成时启动代码分析”,DEBUG状态可根据需要,如代码编写完成测试好的情况下,从菜单手工分析进行修改;然后切换到Release模式下进行生成和分析,查看软件运行情况后,签入代码
代码度量值/Code Metrics
ms-help://MS.VSCC.v90/MS.MSDNQTR.v90.chs/dv_vsetsa01/html/952b6f2e-584f-4c97-a5ba-42d7bd47a576.htm
代码度量是一组软件度量值,使开发人员可以更好地了解他们正在开发的代码。利用代码度量,开发人员可以了解哪些类型和/或方法应该返工或进行更彻底的测试。开发团队可以识别潜在的风险、了解项目的当前状态,并跟踪软件开发的进度。