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

  • 项目
属性 值
规则 ID CA1711
标题 标识符应采用正确的后缀
类别 命名
修复是中断修复还是非中断修复 重大
在 .NET 8 中默认启用 否

原因

标识符的后缀不正确。

默认情况下，此规则仅查看外部可见的标识符，但这是可配置的。

规则说明

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

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

Suffix 基类型/接口
属性 System.Attribute
集合 System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Queue

System.Collections.Stack

System.Collections.Generic.ICollection<T>

System.Data.DataSet

System.Data.DataTable
字典 System.Collections.IDictionary

System.Collections.Generic.IDictionary<TKey,TValue>
EventArgs System.EventArgs
EventHandler 事件处理程序委托
例外 System.Exception
权限 System.Security.IPermission
队列 System.Collections.Queue
堆栈 System.Collections.Stack
Stream System.IO.Stream

此外，不应使用以下后缀：

  • Delegate
  • Enum
  • Impl（请改用 Core）
  • Ex 或类似的后缀，用于与同一类型的早期版本区分开来
  • 枚举类型的 Flag 或 Flags

命名约定为面向公共语言运行时的库提供通用外观。 这缩短了新软件库的学习曲线，让客户更加相信该库是由拥有托管代码开发专业知识的人员开发的。 有关详细信息，请参阅命名准则：类、结构和接口。

如何解决冲突

从类型名称中删除后缀。

何时禁止显示警告

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

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

#pragma warning disable CA1711
// The code that's violating the rule is on this line.
#pragma warning restore CA1711

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

[*.{cs,vb}]
dotnet_diagnostic.CA1711.severity = none

有关详细信息，请参阅如何禁止显示代码分析警告。

配置代码以进行分析

使用下面的选项来配置代码库的哪些部分要运行此规则。

可以仅为此规则、为适用的所有规则或为适用的此类别（命名）中的所有规则配置这些选项。 有关详细信息，请参阅代码质量规则配置选项。

包含特定的 API 图面

你可以根据代码库的可访问性，配置要针对其运行此规则的部分。 例如，若要指定规则应仅针对非公共 API 图面运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.api_surface = private, internal

允许后缀

你可以配置允许的后缀列表，每个后缀用竖线字符分隔（“|”）。 例如，若要指定规则不得针对 Flag 或 Flags 前缀运行，请将以下键值对添加到项目的 .editorconfig 文件中：

dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags

请参阅