CA1711:标识符应采用正确的后缀

类型名

IdentifiersShouldNotHaveIncorrectSuffix

CheckId

CA1711

类别

Microsoft.Naming

是否重大更改

原因

某标识符具有错误的后缀。

规则说明

按照约定,只有扩展某些基类型或实现某些接口的类型的名称或者从这些类型派生的类型的名称,应该以特定的保留后缀结尾。其他类型名称不应使用这些保留的后缀。

下表列出了保留后缀以及与这些保留后缀关联的基类型和接口。

后缀

基类型/接口

特性

Attribute

Collection

ICollection

IEnumerable

Queue

Stack

ICollection

DataSet

DataTable

Dictionary

IDictionary

IDictionary

EventArgs

EventArgs

EventHandler

事件处理程序委托。

例外

Exception

权限

IPermission

Queue

Queue

堆栈

Stack

Stream

另外,不应使用下列后缀:

  • Delegate

  • Enum

  • Impl - 改用“Core”

  • Ex 或类似后缀,用于区别于同一类型的早期版本

命名约定为所有针对公共语言运行时的库提供了通用的外观。这提高了学习新软件库的效率,并使客户进一步认为该软件库是由某位具有开发托管代码专门技术的人员所开发。

如何解决冲突

将后缀从类型名称中移除。

何时禁止显示警告

除非后缀在应用程序域中具有明确的含义,否则不要禁止来自此规则的警告。

相关规则

CA1710:标识符应具有正确的后缀

请参见

其他资源

Attribute Usage Guidelines

事件和委托