代码审查工具StyleCop
转自（http://www.cnblogs.com/shanyou/archive/2009/08/23/StyleCop.html）
“代码审查”或是“代码评审”（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）
常用规则
基础
Invalid spacing around the comma :’,’后面需要加空格(几个无所谓)
Invalid spacing around the opening curly bracket：’{‘前后面需要加空格(仅仅一个，要不然就报’The code contains multiple spaces in a row. Only one space is needed’)
Invalid spacing around the closing curly bracket: ‘}’前面需要加空格(同上)
All using directives must be placed inside of the namespace: using指令需要移到命名空间内
例如：
using System; using System.Text;
Namespace StyleCopDemo { Public class Person { } } //应该为Namespace StyleCopDemo { using System; using System.Text;
Public Class Person { } }
这个我也有点晕了！不过有一篇文章http://blogs.msdn.com/b/abhinaba/archive/2006/08/21/709051.aspx,介绍了这样做的好处！
Adjacent elements must be separated by a blank line:紧邻的元素之间必须用空格行隔开，例如using命名空间和namespace之间。
An opening curly bracket must not be followed by a blank line: ‘{‘下面一行不允许是空行
A closing curly bracket must not be preceded by a blank line: ‘}’上面一行不允许是空行
Using directives must be sorted alphabetically by the namespaces：using语句必须要按照字母排序(顺序)
The code must not contain multiple blank lines in a row:代码中不允许一行中有多行空行。
错误:
正确为:
文档规范：
The class must have a documentation header：定义的类必须含有文件头标志’///’而且其中的内容介绍最好是带有空格的(有点变态)，不然可能会报’ The documentation text within the summary tag does not contain any whitespace between words, indicating that it most likely does not follow a proper grammatical structure required for documentation text’,例如：