使用StyleCop 进行代码评审

使用StyleCop对原代码进行审查，看编写的代码是否遵循设计规范、.Net约定和一些贯用法等。保证代码的一致性，可读性等等。

在此之前，先简单介绍下FxCop（起初只是微软内部使用的工具）,一个分析托管程序集，检测代码的总体正确性的工具，告诉用户哪些地方不符合设计规范。他使用的评估规则已经发展了多年，凝聚了顶尖.Net框架开发人员的知识和技术。但是FxCop是基于托管代码分析的，即编译后的程序集。今天我们介绍的StyleCop同样是用来检查代码是否符合设计规范的，它是基于原代码验证的，仅支持C#语言，就是在开发期间进行代码验证的工具，相信在日常开发中，会帮助到大家，在使用工具的同时，逐渐改善和提高大家的编码规范和意识，另外，相关内容推荐大家读下《.Net设计规范-.Net约定、贯用法与模式》这本书。

首先，还是先下载最新版的StyleCop.，下载地址：http://stylecop.codeplex.com/，更简单的方法是在VisualStudio中，Tools --> Extensions and Updates… --> Extensions and Updates…--> Online --> 搜索stylecop，找到Visual StyleCop并安装。

安装完成之后，打开Visual Studio并打开一个项目，右键选择一个Project，会发现多了三个选项。

Run StyleCop与Run StyleCop(RescanAll)会审查已有代码，并且在Error List中显示代码中不符合规范的Warning，下图是执行了Run StyleCop的Error List

StyleCop Setting：在实际项目中，可能现有的规则并不适用于我们的项目，需要我们自己通过StyleCop Setting进行配置

StyleCop检查的规则包括：

• 布局（Layout ofelements, statements, expressions, and query clauses ）

• 括号位置（Placement ofcurly brackets, parenthesis, square brackets, etc ）

• 空格（Spacing aroundkeywords and operator symbols ）

• 行距（Line spacing ）

• 参数位置（Placement ofmethod parameters within method declarations or method calls ）

• 元素标准排列（Standardordering of elements within a class ）

• 注释格式（Formatting ofdocumentation within element headers and file headers ）

• 命名（Naming ofelements, fields and variables ）

• 内置类型的使用（Use of thebuilt-in types ）

• 访问修饰符的使用（Use of accessmodifiers ）

• 文件内容（Allowed contentsof files ）

• Debugging文本（Debugging text）

---

.NET社区新闻，深度好文，微信中搜索dotNET跨平台或扫描二维码关注