C#静态代码检查工具StyleCode -- 初探
最近我们Advent Data Service (ADS) 在项目上需要按照代码规范进行代码的编写工作，以方便将来代码的阅读与维护。
但是人工检查起来容易遗漏或者格式不统一， ReSharper又是收费的，而且费用不菲。
于是美国的同事推荐了我们一款开源工具 StyleCop，我想无论是对公司项目还是个人的项目，都是有所帮助的，所以想写下来与大家分享。
StyleCop官网地址：http://stylecop.codeplex.com/, 这里有大家需要的msi安装文件，源代码和说明文档等资源。
- 现在最新的版本是 4.7.50，这是一个Alpah版本，支持Visual Studio 2015 （暂时不支持C# 6.0的语法）
- StyleCop有两种安装方式
- 直接在官网下载msi安装程序，双击安装
- 在Visual Studio中，Tools --> Extensions and Updates… --> Extensions and Updates… --> Online --> 搜索stylecop，找到Visual StyleCop并安装
- 安装完成之后，打开Visual Studio并打开一个项目，右键选择一个Project，会发现多了三个选项
- Run StyleCop与Run StyleCop(Rescan All)会审查已有代码，并且在Error List中显示代码中不符合规范的Warning
第一个图是执行了Run StyleCop的Error List, 第二个图是执行了Build的Error List
- StyleCop Setting：在实际项目中，可能现有的规则并不适用于我们的项目，需要我们自己通过StyleCop Setting进行配置
以上都是StyleCop的基本功能，希望能对大家有所帮助，也欢迎大家进行交流讨论。
Tips: 在Visual Studio中，规范化C#项目代码格式的快捷键是Ctrl + k，再按一下Ctrl + d。在编写完代码后，按下这个组合，代码就会规规矩矩的排列了☺
C#静态代码检查工具StyleCode -- 规则解析
在StyleCop中有一些官方自己写好的检测规则，下面就是英文的解释：
Documentation Rules 注释规则
SA1600：ElementsMustBeDocumented元素必须添加注释
SA1601: PartialElementsMustBeDocumented Partial修饰的成员必须添加注释
SA1602：EnumerationItemsMustBeDocumented 枚举必须添加注释
SA1603: DocumentationMustContainValidXml 注释必须合法(注释中的关键字不能有错误)
SA1604: ElementDocumentationMustHaveSummary 元素注释必须包含Summary关键字
SA1605:PartialElementDocumentationMustHaveSummary Partial修饰的成员注释必须包含Summary关键字
SA1606:ElementDocumentationMustHaveSummaryText Summary节点内部必须添加文本
SA1607:PartialElementDocumentationMustHaveSummaryText Partial修饰的成员注释Summary节点内部必须添加文本
SA1608:ElementDocumentationMustNotHaveDefaultSummary Summary注释不能使用编译器自带的注释文本
SA1609:PropertyDocumentationMustHaveValue 属性的注释中必须包含节点
SA1610:PropertyDocumentationMustHaveValueText 属性的注释节点必须包含文本值
SA1611:ElementParametersMustBeDocumented 参数必须注释
SA1612:ElementParameterDocumentationMustMatchElementParameters 参数的个数必须与注释里的个数一致
SA1613:ElementParameterDocumentationMustDeclareParameterName 参数的注释里必须有参数的名称
SA1614:ElementParameterDocumentationMustHaveText 参数注释节点里不能空着
SA1615:ElementReturnValueMustBeDocumented 返回值必须添加注释
SA1616:ElementReturnValueDocumentationMustHaveText 返回值注释的节点内必须有文本值
SA1617:VoidReturnValueMustNotBeDocumented 空返回值一定不能有返回值注释
SA1618:GenericTypeParametersMustBeDocumented 生成的类型(泛型)参数必须有注释
SA1619:GenericTypeParametersMustBeDocumentedPartialClass SA1618情况如果有Partial类存在都要有注释
SA1620:GenericTypeParameterDocumentationMustMatchTypeParameters 注释与泛型必须能匹配上
SA1621:GenericTypeParameterDocumentationMustDeclareParameterName 泛型的注释必须包含泛型定义是的关键字(如’T’)
SA1622:GenericTypeParameterDocumentationMustHaveText 泛型的注释节点中必须包含文本值
SA1623:PropertySummaryDocumentationMustMatchAccessors 属性的注释必须与属性的读写权限匹配，private类型的属性不能出现在注释里
SA1624:PropertySummaryDocumentationMustOmitSetAccessorWithRestrictedAccess 属性的注释里必须忽略protected关键字，当成public类型当注释
SA1625:ElementDocumentationMustNotBeCopiedAndPasted 各个参数的注解不能完全相同(避免copy、post行为)
SA1626:SingleLineCommentsMustNotUseDocumentationStyleSlashes 单行注释不能采取三个斜线的注释方式，斜线的个数必须是二的倍数
SA1627:DocumentationTextMustNotBeEmpty 注释节点内部不能为空(必须有文本值)
SA1628:DocumentationTextMustBeginWithACapitalLetter 注释节点内部的文本必须以大写字母开头
SA1629:DocumentationTextMustEndWithAPeriod 注释节点内部的文本必须英文的句号结束
SA1630:DocumentationTextMustContainWhitespace 注释节点内部的文本必须包含空格
SA1631:DocumentationMustMeetCharacterPercentage 注释节点内部的文本中不能包含过多的字符(举例:包含’—————————————’是不允许的)
SA1632:DocumentationTextMustMeetMinimumCharacterLength 已经作废的规则，不允许有太短的字符串(如’A name’ 中的A字母)
SA1633:FileMustHaveHeader 代码文件头部必须有说明，一般放置版权信息
SA1634:FileHeaderMustShowCopyright 代码文件头部注解中必须包含版权关键字
SA1635:FileHeaderMustHaveCopyrightText代码文件头部注解中必须包含版权信息内同
SA1636:FileHeaderCopyrightTextMustMatch 代码文件头部注解中版权信息必须与设置画面设置的内容相匹配，在”style seting”画面的” Company Information tab”进行设置
SA1637:FileHeaderMustContainFileName 代码文件头部注解中必须包含文件名称
SA1638:FileHeaderFileNameDocumentationMustMatchFileName 代码文件头部注解中必须包含文件名称必须与实际的名称匹配
SA1639:FileHeaderMustHaveSummary 代码文件头部注解中必须包含Summary节点
SA1640:FileHeaderMustHaveValidCompanyText 代码文件头部注解中版权信息必须含有合理的公司名字
SA1641:FileHeaderCompanyNameTextMustMatch 代码文件头部注解中的公司名字必须与设置画面设置的内容相匹配，在”style seting”画面的” Company Information tab”进行设置
SA1642:ConstructorSummaryDocumentationMustBeginWithStandardText 构造函数注释标准：“Initializes a new instance of the class.”
SA1643:DestructorSummaryDocumentationMustBeginWithStandardText 析构函数注释标准：“Finalizes an instance of the class.”
SA1644:DocumentationHeadersMustNotContainBlankLines 注释中不能出现空白行
SA1645:IncludedDocumentationFileDoesNotExist 如果注释中包含文件，要确定这个文件存在，举例：“ /// ” 这一项过于复杂不建议用，但是如果将来想规范化相同共性东西的注释的时候倒是可以考虑引入。
SA1646:IncludedDocumentationXPathDoesNotExist 如果注释中包含文件，路径不存在。
SA1647:IncludeNodeDoesNotContainValidFileAndPath 如果注释中包含文件 文件与路径都要合法
SA1648:InheritDocMustBeUsedWithInheritingClass 这项不明白是什么意思，还请知道的分享给我，谢谢。
SA1649:FileHeaderFileNameDocumentationMustMatchTypeName 文件头注释必须匹配类型
SA1650:ElementDocumentationMustBeSpelledCorrectly 注释不能有拼写错误(对中文支持不好，不建议使用该项)
Layout Rules 布局规则
-
SA1500:CurlyBracketsForMultiLineStatementsMustNotShareLine 花括号不能再同一行。
标准格式： public StRsvrRFun() { } SA1501:StatementMustNotBeOnASingleLine 语句不能共享一行
SA1502:ElementMustNotBeOnASingleLine 语句不能共享一行
SA1503:CurlyBracketsMustNotBeOmitted 花括弧即使在单行代码的情况下也不能省略。
SA1504:AllAccessorsMustBeSingleLineOrMultiLine 读写属性，要么在同一行业要么在分多行写，不可规则不统一(个人建议分多行写)。
SA1505:OpeningCurlyBracketsMustNotBeFollowedByBlankLine 开始的花括弧后面不能有空白行
SA1506:ElementDocumentationHeadersMustNotBeFollowedByBlankLine 元素头部注释跟元素之间不能有空白行
SA1507:CodeMustNotContainMultipleBlankLinesInARow 不允许有多行空白行紧挨着(个人建议写一个空白行即可)
SA1508:ClosingCurlyBracketsMustNotBePrecededByBlankLine 结尾的花括弧不能再一个空白行之前
SA1509:OpeningCurlyBracketsMustNotBePrecededByBlankLine 开始的花括弧不能再一个空白行之前
SA1510:ChainedStatementBlocksMustNotBePrecededByBlankLine 相连的语句之间不能有空白行，如try语句与catch语句之间不能有空白行
SA1511:WhileDoFooterMustNotBePrecededByBlankLine 与SA1510相同，Do语句与While语句之间不能有空白行
SA1512:SingleLineCommentsMustNotBeFollowedByBlankLine 单行注释不能后跟空白行
SA1513:ClosingCurlyBracketMustBeFollowedByBlankLine 结束花括弧之后必须有一个空白行
SA1514:ElementDocumentationHeaderMustBePrecededByBlankLine 头部注解之前必须有一个空白行
SA1515:SingleLineCommentMustBePrecededByBlankLine 单行注释之前要有一个空白行，还一种方法是不加空白行而用四个斜线注释”////”,建议采取第一种方法
SA1516:ElementsMustBeSeparatedByBlankLine 邻近的元素之间要有一个空白行
SA1517:CodeMustNotContainBlankLinesAtStartOfFile 代码文件头部字符之前不能出现空白行
SA1518:CodeMustNotContainBlankLinesAtEndOfFile代码文件尾部字符之后不能出现空白行
Maintainability Rules 可维护规则
SA1119:StatementMustNotUseUnnecessaryParenthesis 语句中不可以出现多余的括弧，无意义的括弧增加了代码的可读性
SA1400:AccessModifierMustBeDeclared 必须定义访问修饰符
SA1401:FieldsMustBePrivate 字段必须定义为私有的
SA1402:FileMayOnlyContainASingleClass 一个CS文件里只定义一个类
SA1403:FileMayOnlyContainASingleNamespace 一个CS文件只包含一个命名空间
SA1404:CodeAnalysisSuppressionMustHaveJustification Suppression特性(取消报告特定的静态分析工具规则冲突，允许一个代码项目上应用多个取消报告设置)必须要有合理理由
SA1405:DebugAssertMustProvideMessageText 参见代码：“Debug.Assert(value != true, “The value must always be true.”);”
SA1406:DebugFailMustProvideMessageText 参见代码：“Debug.Fail(“The code should never reach this point.”);”
SA1407:ArithmeticExpressionsMustDeclarePrecedence 算数表达式必须用明确的标明其优先级(此条与SA1119冲突)
SA1408:ConditionalExpressionsMustDeclarePrecedence 条件表达式必须明确的标明其优先级(此条与SA1119冲突) 举例：“if (x || (y && z && a) || b)”
SA1409:RemoveUnnecessaryCode 移除无用的代码
SA1410:RemoveDelegateParenthesisWhenPossible 调用一个c#匿名方法不包含任何方法参数,必须要包括一个空括号(本人不建议使用匿名方法、匿名委托的语法，具体原因后续做分享)
SA1411:AttributeConstructorMustNotUseUnnecessaryParenthesis 特性构造函数如果是空参的形式，不要包括那个空括号
Naming Rules 命名规则
SA1300:ElementMustBeginWithUpperCaseLetter 首字母必须大写(个人理解应该是字段以外的东西)
SA1301: ElementMustBeginWithLowerCaseLetter 不会出现的情况
SA1302:InterfaceNamesMustBeginWithI 接口必须以“I”字母开头
SA1303:ConstFieldNamesMustBeginWithUpperCaseLetter Const常量首字母大写
SA1304:NonPrivateReadonlyFieldsMustBeginWithUpperCaseLetter 非私有非制度的字段必须首字母大写
SA1305:FieldNamesMustNotUseHungarianNotation 除了列表外的字符不可以出现匈牙利命名规则,在”Style Setting”里的” Hungarian”Tab里设置
SA1306:FieldNamesMustBeginWithLowerCaseLetter 字段名必须首字母小写
SA1307:AccessibleFieldsMustBeginWithUpperCaseLetter public或者internal字段首字母大写
SA1308:VariableNamesMustNotBePrefixed 变量名不能有前缀
SA1309:FieldNamesMustNotBeginWithUnderscore 字段名不能以下滑线开头
SA1310:FieldNamesMustNotContainUnderscore 字段名不能包括下滑线
SA1311:StaticReadonlyFieldsMustBeginWithUpperCaseLetter static与readonly字段首字母大写
Ordering Rules 排序规则
SA1200:UsingDirectivesMustBePlacedWithinNamespace using部分必须在Namespace内部(个人不建议用这个规则)
SA1201:ElementsMustAppearInTheCorrectOrder 所有的元素必须出现在正确的位置上(个人不建议使用该规则，用region把一个类文件里的元素分好组即可，字段、属性、对外公布的接口、私有方法等组)
SA1202:ElementsMustBeOrderedByAccess 元素的修饰符有一个固定的顺序(个人不建议使用该规则，用region把一个类文件里的元素分好组即可，字段、属性、对外公布的接口、私有方法等组)
SA1203:ConstantsMustAppearBeforeFields 常量字段摆放在其它字段之上
SA1204:StaticElementsMustAppearBeforeInstanceElements Static 元素摆放在前面
SA1205:PartialElementsMustDeclareAccess Partial修饰的元素必须声明读写权限
-
SA1206:DeclarationKeywordsMustFollowOrder 举例：
keywords must appear in the following order: Access modifiers static All other keywords SA1207:ProtectedMustComeBeforeInternal Protected在Internal之前
SA1208:SystemUsingDirectivesMustBePlacedBeforeOtherUsingDirectives 系统级的引用在其他引用之前(格式化代码就会自动按照这个规则编排using部分)
SA1209:UsingAliasDirectivesMustBePlacedAfterOtherUsingDirectives using部分起别名的在最后排布
SA1210:UsingDirectivesMustBeOrderedAlphabeticallyByNamespace using部分按照字母顺序编排
SA1211:UsingAliasDirectivesMustBeOrderedAlphabeticallyByAliasName 别名的按照别名的字母编排
SA1212:PropertyAccessorsMustFollowOrder 属性按照先get在set
SA1213:EventAccessorsMustFollowOrder 时间先remove在add
SA1214:StaticReadonlyElementsMustAppearBeforeStaticNonReadonlyElements StaticReadonly元素在StaticNonReadonly元素之前
SA1215:InstanceReadonlyElementsMustAppearBeforeInstanceNonReadonlyElements 一个readonly 实例元素要在一个非readonly 实例元素
Readability Rules 可读性规则
-
SA1100:DoNotPrefixCallsWithBaseUnlessLocalImplementationExists
change the ‘base.’ prefix to ‘this.’. SA1101:PrefixLocalCallsWithThis ‘this.’前缀不能省略
SA1102:QueryClauseMustFollowPreviousClause linq语句要么同一行，要么关键字分布在多行，关键字对齐
SA1103:QueryClausesMustBeOnSeparateLinesOrAllOnOneLine 不是很理解
SA1104:QueryClauseMustBeginOnNewLineWhenPreviousClauseSpansMultipleLines不是很理解
SA1105:QueryClausesSpanningMultipleLinesMustBeginOnOwnLine不是很理解
SA1106:CodeMustNotContainEmptyStatements 不允许有空白的声明
SA1107:CodeMustNotContainMultipleStatementsOnOneLine 同一行里不允许出现多个声明语句
-
SA1108:BlockStatementsMustNotContainEmbeddedComments 非法用例：
if (x != y) // Make sure x does not equal y { } -
SA1109:BlockStatementsMustNotContainEmbeddedRegions 非法用例：
if (x != y) #region { } #endregion SA1110:OpeningParenthesisMustBeOnDeclarationLine 方法开始的括弧要在声明的那一行
SA1111:ClosingParenthesisMustBeOnLineOfLastParameter 方法结束括弧与最后一个参数同行
SA1112:ClosingParenthesisMustBeOnLineOfOpeningParenthesis 如果是空参的情况，开始于结束括弧在同一行
SA1113:CommaMustBeOnSameLineAsPreviousParameter 逗号必须与前一个参数同行
SA1114:ParameterListMustFollowDeclaration 确保参数列表与开始括号同行，或者另起一行 参数整体要在同一行
SA1115:ParameterMustFollowComma 参数与参数之间不能隔空白行
-
SA1116:SplitParametersMustStartOnLineAfterDeclaration 所有参数在同一行或者如下示例：
public string JoinName( string first, string last) SA1117:ParametersMustBeOnSameLineOrSeparateLines 同上
SA1118:ParameterMustNotSpanMultipleLines 实际调用是参数要在同一行
SA1120:CommentsMustContainText 注释必须节点内部必须有文本
-
SA1122:UseStringEmptyForEmptyStrings
示例代码：“string s = string.Empty;”不能写成” string s = ""; ” SA1123:DoNotPlaceRegionsWithinElements 不使用region(个人较反对这条，个人倾向于用region规整类里的元素)
SA1124:DoNotUseRegions 不使用region(个人较反对这条，个人倾向于用region规整类里的元素)
SA1125:UseShorthandForNullableTypes 使用简写版的可空类型 如”int?”
SA1126:PrefixCallsCorrectly 调用类成员的时候要带上“this”前缀
Spacing Rules 拼写规则
SA1000:KeywordsMustBeSpacedCorrectly 关键字不能拼写错误
SA1001:CommasMustBeSpacedCorrectly 逗号前面摆放一个空格
SA1002:SemicolonsMustBeSpacedCorrectly 分号前面摆放一个空格
SA1003:SymbolsMustBeSpacedCorrectly 操作符与元素之间不加空格
SA1004:DocumentationLinesMustBeginWithSingleSpace “///”注释的每一行以一个空格开头
SA1005:SingleLineCommentsMustBeginWithSingleSpace 单行注释以一个空格开头
SA1006:PreprocessorKeywordsMustNotBePrecededBySpace 预处理关键字内部不允许出现空格 如“# if Debug”是不允许的
SA1007:OperatorKeywordMustBeFollowedBySpace 操作必须要在一个空格之后
SA1008:OpeningParenthesisMustBeSpacedCorrectly 开始括弧放置合理的空格
SA1009:ClosingParenthesisMustBeSpacedCorrectly 结尾括弧放置合理的空格
SA1010:OpeningSquareBracketsMustBeSpacedCorrectly 开始方括号放置合理的空格
SA1011:ClosingSquareBracketsMustBeSpacedCorrectly 结束方括号放置合理的空格
SA1012:OpeningCurlyBracketsMustBeSpacedCorrectly 开始花括号放置合理的空格
SA1013:ClosingCurlyBracketsMustBeSpacedCorrectly 结束花括号放置合理的空格
SA1014:OpeningGenericBracketsMustBeSpacedCorrectly 同上
SA1015:ClosingGenericBracketsMustBeSpacedCorrectly 同上
SA1016:OpeningAttributeBracketsMustBeSpacedCorrectly 特性开始括号同上
SA1017:ClosingAttributeBracketsMustBeSpacedCorrectly 特性结尾括号同上
SA1018:NullableTypeSymbolsMustNotBePrecededBySpace 空类型前不放置空格
SA1019:MemberAccessSymbolsMustBeSpacedCorrectly 成员访问关键字前后有空格
SA1020:IncrementDecrementSymbolsMustBeSpacedCorrectly 自增、自减关键字要有空格
SA1021:NegativeSignsMustBeSpacedCorrectly 负号要有空格
SA1022:PositiveSignsMustBeSpacedCorrectly 正号要有空格
SA1023:DereferenceAndAccessOfMustBeSpacedCorrectly
SA1024:ColonsMustBeSpacedCorrectly 冒号运算符要有空格
SA1025:CodeMustNotContainMultipleWhitespaceInARow 同一行不允许出现多个空格
SA1026:CodeMustNotContainSpaceAfterNewKeywordInImplicitlyTypedArrayAllocation new关键字之后不允许出现空格
SA1027:TabsMustNotBeUsed 不用tab字符(个人不建议采用这条)
C#静态代码检查工具StyleCode -- 自定义规则
本文将简单的一步一步的指导这可能有助于学习如何创建自己的规则
1、创建一个项目。
Visual Studio创建一个新的类库项目.NET3.5
2、引用两个DLL，StyleCop.dll和StyleCop.Csharp.dll.
3、添加自定义的规则。
MyCustomAnalyzer.cs代码如下：
- using StyleCop;
- using StyleCop.CSharp;
- namespace MyCustomRules
- {
- /// <summary>
- /// Custom analyzer for demo purposes.
- /// </summary>
- [SourceAnalyzer(typeof(CsParser))]
- public class MyCustomAnalyzer : SourceAnalyzer
- {
- /// <summary>
- /// Extremely simple analyzer for demo purposes.
- /// </summary>
- public override void AnalyzeDocument(CodeDocument document)
- {
- CsDocument doc = (CsDocument)document;
- // skipping wrong or auto-generated documents
- if (doc.RootElement == null || doc.RootElement.Generated)
- return;
- // check all class entries
- doc.WalkDocument(CheckClasses);
- }
- /// <summary>
- /// Checks whether specified element conforms custom rule CR0001.
- /// </summary>
- private bool CheckClasses(
- CsElement element,
- CsElement parentElement,
- object context)
- {
- // if current element is not a class then continue walking
- if (element.ElementType != ElementType.Class)
- return true;
- // check whether class name contains "a" letter
- Class classElement = (Class)element;
- if (classElement.Declaration.Name.Contains("a"))
- {
- // add violation
- // (note how custom message arguments could be used)
- AddViolation(
- classElement,
- classElement.Location,
- "AvoidUsingAInClassNames",
- classElement.FriendlyTypeText);
- }
- // continue walking in order to find all classes in file
- return true;
- }
- }
- }
4、添加一个规则的XML文件，命名和上面类的名字一样。
把以下内容写到MyCustomAnalyzer.xml文件中
- <?xml version="1.0" encoding="utf-8" ?>
- <SourceAnalyzer Name="My Custom Rule">
- <Description>
- Custom rule for demo purposes.
- </Description>
- <Rules>
- <Rule Name="AvoidUsingAInClassNames" CheckId="CR0001">
- <Context>不能用A字母</Context>
- <Description>Fires when 'a' letter is used in class name.</Description>
- </Rule>
- </Rules>
- </SourceAnalyzer>
5、构建
将这个项目生成DLL，把MyCustomAnalyzer.dll放到StyleCop根目录下。
6、部署
打开一个我们要测试的项目代码。点击StyleCop Setting设置用我们的MyCoustomRule。
7、点击RunStyleCop在错误警告列表就会显示检测出来的规则验证。如图：
