命名规则
命名规则支持遵从 .NET 设计准则的命名约定。
在本节中
规则 | 描述 |
---|---|
CA1700:不要命名“Reserved”枚举值 | 此规则假定当前不使用名称中包含“reserved”的枚举成员,而是将其作为一个占位符,以在将来的版本中重命名或移除它。 重命名或移除成员是一项重大更改。 |
CA1707:标识符不应包含下划线 | 按照约定,标识符名称不包含下划线 (_) 字符。 该规则将检查命名空间、类型、成员和参数。 |
CA1708:标识符应以大小写之外的差别进行区分 | 不能仅通过大小写区分命名空间、类型、成员和参数的标识符,因为针对公共语言运行时的语言不需要区分大小写。 |
CA1710:标识符应具有正确的后缀 | 按照约定,扩展某些基类型或实现某些接口的类型的名称,或者由这些类型派生的类型的名称应具有与相应基类型或接口关联的后缀。 |
CA1711:标识符应采用正确的后缀 | 按照约定,只有扩展某些基类型或实现某些接口的类型的名称或者从这些类型派生的类型的名称,应该以特定的保留后缀结尾。 其他类型名称不应使用这些保留的后缀。 |
CA1712:不要将类型名用作枚举值的前缀 | 枚举成员的名称不使用类型名称作为前缀,因为类型信息将由开发工具提供。 |
CA1713:事件不应具有 before 或 after 前缀 | 事件的名称以“Before”或“After”开头。 若要命名按特定顺序引发的相关事件,请使用现在时或过去时指示一系列操作中的相对位置。 |
CA1714:Flags 枚举应采用复数形式的名称 | 公共枚举具有 System.FlagsAttribute 特性并且其名称不是以“s”结尾。 用 FlagsAttribute 标记的类型具有复数形式的名称,因为该特性指明可以指定多个值。 |
CA1715:标识符应具有正确的前缀 | 外部可见的接口的名称不以大写的“I”开头。 外部可见的类型或方法上的泛型类型参数的名称不以大写的“T”开头。 |
CA1716:标识符不应与关键字冲突 | 某个命名空间名称或类型名称与编程语言中的保留关键字相同。 命名空间和类型的标识符不应与针对公共语言运行时的语言所定义的关键字冲突。 |
CA1717:只有 FlagsAttribute 枚举应采用复数形式的名称 | 命名约定规定,复数形式的枚举名称表示可以同时指定多个枚举值。 |
CA1720:标识符不应包含类型名称 | 外部可见成员中的某个参数的名称包含一个数据类型名称,或者外部可见成员的名称包含一个语言特定的数据类型名称。 |
CA1721:属性名不应与 get 方法冲突 | 公共或受保护成员的名称以“Get”开头,且其余部分与公共或受保护属性的名称匹配。 “Get”方法和属性的名称应能够明确区分其功能上的差异。 |
CA1724:类型名不应与命名空间冲突 | 类型名不应与 .NET 命名空间的名称匹配。 与该规则冲突将使库的可用性下降。 |
CA1725:参数名应与基方法中的声明保持一致 | 以一致的方式命名重写层次结构中的参数可以提高方法重写的可用性。 如果派生方法中的参数名与基声明中的名称不同,可能会导致无法区分出该方法是基方法的重写还是该方法的新重载。 |
CA1727:将 PascalCase 用于已命名占位符 | 在日志记录消息模板中将 PascalCase 用于已命名占位符。 |