C#代码规范和质量检查工具

时间 2019-11-16

标签 c# 代码规范质量检查工具栏目 C# 繁體版

原文原文链接

代码风格检查：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.c#

代码缺陷检查：FxCopapi

代码分析工具，帮助您检测和更正代码缺陷。app

托管代码代码分析工具分析托管程序集并报告有关程序集的信息，例如 Microsoft .NET Framework 设计准则中规定的编程和设计规则的冲突。分析工具将它在分析期间执行的检查表示为警告。less

代码质量: 代码度量值/Code Metricside

代码度量是一组软件度量值，使开发人员能够更好地了解他们正在开发的代码。利用代码度量，开发人员能够了解哪些类型和/或方法应该返工或进行更完全的测试。开发团队能够识别潜在的风险、了解项目的当前状态，并跟踪软件开发的进度。函数

在StyleCop中有一些官方本身写好的检测规则下面就是英文的解释工具

文档规则布局

一、SA1600：ElementsMustBeDocumented元素必须添加注释post

二、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 属性的注释中必须包含<Value>节点

十一、SA1610:PropertyDocumentationMustHaveValueText 属性的注释<Value>节点必须包含文本值

十二、SA1611:ElementParametersMustBeDocumented 参数必须注释

1三、SA1612:ElementParameterDocumentationMustMatchElementParameters 参数的个数必须与注释里的个数一致

1四、SA1613:ElementParameterDocumentationMustDeclareParameterName 参数的注释里必须有参数的名称

1五、SA1614:ElementParameterDocumentationMustHaveText 参数注释节点里不能空着

1六、SA1615:ElementReturnValueMustBeDocumented 返回值必须添加注释

1七、SA1616:ElementReturnValueDocumentationMustHaveText 返回值注释的节点内必须有文本值

1八、SA1617:VoidReturnValueMustNotBeDocumented 空返回值必定不能有返回值注释

1九、SA1618:GenericTypeParametersMustBeDocumented 生成的类型(泛型)参数必须有注释

20、SA1619:GenericTypeParametersMustBeDocumentedPartialClass SA1618状况若是有Partial类存在都要有注释

2一、SA1620:GenericTypeParameterDocumentationMustMatchTypeParameters 注释与泛型必须能匹配上

2二、SA1621:GenericTypeParameterDocumentationMustDeclareParameterName 泛型的注释必须包含泛型定义是的关键字(如’T’)

2三、SA1622:GenericTypeParameterDocumentationMustHaveText 泛型的注释节点中必须包含文本值

2四、SA1623:PropertySummaryDocumentationMustMatchAccessors 属性的注释必须与属性的读写权限匹配，private类型的属性不能出如今注释里

2五、SA1624:PropertySummaryDocumentationMustOmitSetAccessorWithRestrictedAccess 属性的注释里必须忽略protected关键字，当成public类型当注释

2六、SA1625:ElementDocumentationMustNotBeCopiedAndPasted 各个参数的注解不能彻底相同(避免copy、post行为)

2七、SA1626:SingleLineCommentsMustNotUseDocumentationStyleSlashes 单行注释不能采起三个斜线的注释方式，斜线的个数必须是二的倍数

2八、SA1627:DocumentationTextMustNotBeEmpty 注释节点内部不能为空(必须有文本值)

2九、SA1628:DocumentationTextMustBeginWithACapitalLetter 注释节点内部的文本必须以大写字母开头

30、SA1629:DocumentationTextMustEndWithAPeriod 注释节点内部的文本必须英文的句号结束

3一、SA1630:DocumentationTextMustContainWhitespace 注释节点内部的文本必须包含空格

3二、SA1631:DocumentationMustMeetCharacterPercentage 注释节点内部的文本中不能包含过多的字符(举例:包含’---------------------------------------’是不容许的)

3三、SA1632:DocumentationTextMustMeetMinimumCharacterLength 已经做废的规则，不容许有过短的字符串(如’A name’ 中的A字母)

3四、SA1633:FileMustHaveHeader 代码文件头部必须有说明，通常放置版权信息

3五、SA1634:FileHeaderMustShowCopyright 代码文件头部注解中必须包含版权关键字

3六、SA1635:FileHeaderMustHaveCopyrightText代码文件头部注解中必须包含版权信息内同

3七、SA1636:FileHeaderCopyrightTextMustMatch 代码文件头部注解中版权信息必须与设置画面设置的内容相匹配，在”style seting”画面的” Company Information tab”进行设置

3八、SA1637:FileHeaderMustContainFileName 代码文件头部注解中必须包含文件名称

3九、SA1638:FileHeaderFileNameDocumentationMustMatchFileName 代码文件头部注解中必须包含文件名称必须与实际的名称匹配

40、SA1639:FileHeaderMustHaveSummary 代码文件头部注解中必须包含Summary节点

4一、SA1640:FileHeaderMustHaveValidCompanyText 代码文件头部注解中版权信息必须含有合理的公司名字

4二、SA1641:FileHeaderCompanyNameTextMustMatch 代码文件头部注解中的公司名字必须与设置画面设置的内容相匹配，在”style seting”画面的” Company Information tab”进行设置

4三、SA1642:ConstructorSummaryDocumentationMustBeginWithStandardText 构造函数注释标准：“Initializes a new instance of the <see cref="Customer{T}"/> class.”

4四、SA1643:DestructorSummaryDocumentationMustBeginWithStandardText 析构函数注释标准：“Finalizes an instance of the <see cref="Customer"/> class.”

4五、SA1644:DocumentationHeadersMustNotContainBlankLines 注释中不能出现空白行

4六、SA1645:IncludedDocumentationFileDoesNotExist 若是注释中包含文件，要肯定这个文件存在，举例：“ /// <include file="IncludedDocumentation.xml" path="root/EnabledMethodDocs" />” 这一项过于复杂不建议用，可是若是未来想规范化相同共性东西的注释的时候却是能够考虑引入。

4七、SA1646:IncludedDocumentationXPathDoesNotExist 若是注释中包含文件，路径不存在。

4八、SA1647:IncludeNodeDoesNotContainValidFileAndPath 若是注释中包含文件文件与路径都要合法

4九、SA1648:InheritDocMustBeUsedWithInheritingClass 这项不明白是什么意思，还请知道的分享给我，谢谢。

50、SA1649:FileHeaderFileNameDocumentationMustMatchTypeName 文件头注释必须匹配类型

5一、SA1650:ElementDocumentationMustBeSpelledCorrectly 注释不能有拼写错误(对中文支持很差，不建议使用该项)

布局规则

一、 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语句之间不能有空白行

1三、SA1512:SingleLineCommentsMustNotBeFollowedByBlankLine 单行注释不能后跟空白行

1四、SA1513:ClosingCurlyBracketMustBeFollowedByBlankLine 结束花括弧以后必须有一个空白行

1五、SA1514:ElementDocumentationHeaderMustBePrecededByBlankLine 头部注解以前必须有一个空白行

1六、SA1515:SingleLineCommentMustBePrecededByBlankLine 单行注释以前要有一个空白行，还一种方法是不加空白行而用四个斜线注释”////”,建议采起第一种方法

1七、SA1516:ElementsMustBeSeparatedByBlankLine 邻近的元素之间要有一个空白行

1八、SA1517:CodeMustNotContainBlankLinesAtStartOfFile 代码文件头部字符以前不能出现空白行

1九、SA1518:CodeMustNotContainBlankLinesAtEndOfFile代码文件尾部字符以后不能出现空白行

可维护规则

一、 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#匿名方法不包含任何方法参数,必需要包括一个空括号(本人不建议使用匿名方法、匿名委托的语法，具体缘由后续作分享)

1三、 SA1411:AttributeConstructorMustNotUseUnnecessaryParenthesis 特性构造函数若是是空参的形式，不要包括那个空括号

命名规则

一、 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字段首字母大写

排序规则

一、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 别名的按照别名的字母编排

1三、SA1212:PropertyAccessorsMustFollowOrder 属性按照先get在set

1四、SA1213:EventAccessorsMustFollowOrder 时间先remove在add

1五、SA1214:StaticReadonlyElementsMustAppearBeforeStaticNonReadonlyElements StaticReadonly元素在StaticNonReadonly元素以前

1六、SA1215:InstanceReadonlyElementsMustAppearBeforeInstanceNonReadonlyElements

一个readonly 实例元素要在一个非readonly 实例元素

可读性规则

一、 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 方法结束括弧与最后一个参数同行

1三、 SA1112:ClosingParenthesisMustBeOnLineOfOpeningParenthesis 若是是空参的状况，开始于结束括弧在同一行

1四、 SA1113:CommaMustBeOnSameLineAsPreviousParameter 逗号必须与前一个参数同行

1五、 SA1114:ParameterListMustFollowDeclaration

确保参数列表与开始括号同行，或者另起一行参数总体要在同一行

1六、 SA1115:ParameterMustFollowComma 参数与参数之间不能隔空白行

1七、 SA1116:SplitParametersMustStartOnLineAfterDeclaration 全部参数在同一行或者以下示例：

public string JoinName(

string first,

string last)

1八、SA1117:ParametersMustBeOnSameLineOrSeparateLines 同上

1九、SA1118:ParameterMustNotSpanMultipleLines 实际调用是参数要在同一行

20、SA1120:CommentsMustContainText 注释必须节点内部必须有文本

2二、SA1122:UseStringEmptyForEmptyStrings

示例代码：“string s = string.Empty;”不能写成” string s = ""; ”

2三、SA1123:DoNotPlaceRegionsWithinElements 不使用region(我的较反对这条，我的倾向于用region规整类里的元素)

2四、SA1124:DoNotUseRegions 不使用region(我的较反对这条，我的倾向于用region规整类里的元素)

2五、SA1125:UseShorthandForNullableTypes 使用简写版的可空类型如”int?”

2六、SA1126:PrefixCallsCorrectly 调用类成员的时候要带上“this”前缀

拼写规则

一、 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 结束方括号放置合理的空格

1三、 SA1012:OpeningCurlyBracketsMustBeSpacedCorrectly 开始花括号放置合理的空格

1四、 SA1013:ClosingCurlyBracketsMustBeSpacedCorrectly 结束花括号放置合理的空格

1五、 SA1014:OpeningGenericBracketsMustBeSpacedCorrectly 同上

1六、 SA1015:ClosingGenericBracketsMustBeSpacedCorrectly 同上

1七、 SA1016:OpeningAttributeBracketsMustBeSpacedCorrectly 特性开始括号同上

1八、 SA1017:ClosingAttributeBracketsMustBeSpacedCorrectly 特性结尾括号同上

1九、 SA1018:NullableTypeSymbolsMustNotBePrecededBySpace 空类型前不放置空格

20、 SA1019:MemberAccessSymbolsMustBeSpacedCorrectly 成员访问关键字先后有空格

2一、 SA1020:IncrementDecrementSymbolsMustBeSpacedCorrectly 自增、自减关键字要有空格

2二、 SA1021:NegativeSignsMustBeSpacedCorrectly 负号要有空格

2三、 SA1022:PositiveSignsMustBeSpacedCorrectly 正号要有空格

2四、 SA1023:DereferenceAndAccessOfMustBeSpacedCorrectly

2五、 SA1024:ColonsMustBeSpacedCorrectly 冒号运算符要有空格

2六、 SA1025:CodeMustNotContainMultipleWhitespaceInARow 同一行不容许出现多个空格

2七、 SA1026:CodeMustNotContainSpaceAfterNewKeywordInImplicitlyTypedArrayAllocation new关键字以后不容许出现空格

2八、 SA1027:TabsMustNotBeUsed 不用tab字符(我的不建议采用这条)