当前位置: 首页 > 工具软件 > StyleCop > 使用案例 >

SH2Group StyleCop 配置

乐正锦
2023-12-01


文档规则:

SA1600:ElementsMustBeDocumented元素必须添加注释

SA1601: PartialElementsMustBeDocumented   Partial修饰的成员必须添加注释

SA1602:EnumerationItemsMustBeDocumented 枚举必须添加注释

SA1604: ElementDocumentationMustHaveSummary 元素注释必须包含Summary关键字

SA1605:PartialElementDocumentationMustHaveSummary   Partial修饰的成员注释必须包含Summary关键字

SA1606:ElementDocumentationMustHaveSummaryText   Summary节点内部必须添加文本

SA1607:PartialElementDocumentationMustHaveSummaryText  Partial修饰的成员注释Summary节点内部必须添加文本

SA1611:ElementParametersMustBeDocumented   参数必须注释

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

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

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

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

SA1625:ElementDocumentationMustNotBeCopiedAndPasted  各个参数的注解不能完全相同(避免copy、post行为)

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

SA1507:CodeMustNotContainMultipleBlankLinesInARow 不允许有多行空白行紧挨着(个人建议写一个空白行即可)

SA1508:ClosingCurlyBracketsMustNotBePrecededByBlankLine 结尾的花括弧不能再一个空白行之前

SA1509:OpeningCurlyBracketsMustNotBePrecededByBlankLine  开始的花括弧不能再一个空白行之前


命名规则:

SA1300:ElementMustBeginWithUpperCaseLetter  首字母必须大写(个人理解应该是字段以外的东西)

SA1302:InterfaceNamesMustBeginWithI  接口必须以“I”字母开头

SA1303:ConstFieldNamesMustBeginWithUpperCaseLetter Const常量首字母大写

 类似资料: