代码审查工具StyleCop

“代码审查”或是“代码评审”（Code Review），这是一个流程，当开发人员写好代码后，需要让别人来review一下他的代码，这是一种有效发现BUG的方法。由此，我们可以审查代码的风格、逻辑、思路……，找出问题，以及改进代码。因为这是代码刚刚出炉的时候，所以，这也是代码重构，代码调整，代码修改的最佳时候。所以，Code Review是编码实现中最最重要的一个环节。

长时间以来，Code Review需要有一些有效的工具来支持，这样我们就可以更容易，更有效率地来进行代码审查工作。

StyleCop是代码规范检查工具（Code Review 工具），它不仅仅检查代码格式，而是编码规范，包括命名和注释等。StyleCop可以帮助你更容易地进行这项活动。StyleCop现在包含了 200 个左右的最佳实践规则（best practice rules），这些规则与 Visual Studio 2005 和  Visual Studio 2008 中默认的代码格式化规则是一致的。它会根据预定义的C#代码格式的最佳实践，对我们的源代码进行检查，并给出不符合编码风格的错误提示。这一点来说与微软的另一个代码检查工具 FxCop 很相似，但 FxCop 是对 dll （compiled binaries） 进行检查，所以 FxCop 适用于新项目通过持续集成工具来使用的情况。也就是说 FxCop 是项目级别的，而 StyleCop是代码级别的，更适合于程序员在编程过程中使用。

StyleCop检查的规则包括：

• 布局（Layout of elements, statements, expressions, and query clauses ）
• 括号位置（Placement of curly brackets, parenthesis, square brackets, etc ）
• 空格（Spacing around keywords and operator symbols ）
• 行距（Line spacing ）
• 参数位置（Placement of method parameters within method declarations or method calls ）
• 元素标准排列（Standard ordering of elements within a class ）
• 注释格式（Formatting of documentation within element headers and file headers ）
• 命名（Naming of elements, fields and variables ）
• 内置类型的使用（Use of the built-in types ）
• 访问修饰符的使用（Use of access modifiers ）
• 文件内容（Allowed contents of files ）
• Debugging文本（Debugging text）

  StyleCop放在 http://code.msdn.microsoft.com/sourceanalysis，最新版本是2009年8月10日发布 4.3.2.1版本。更多的信息可以关注StyleCop开发团队的blog：http://blogs.msdn.com/sourceanalysis

  CodeProject上有一篇文章详细的讲述StyleCop的使用方法 C# Code Reviews using StyleCop – Detailed Article

  msdn杂志：适用于 .NET 的静态分析工具