CA1716:标识符不应与关键字冲突

  • 项目
属性 值
规则 ID CA1716
标题 标识符不应与关键字冲突
类别 命名
修复是中断修复还是非中断修复 重大
在 .NET 8 中默认启用 否

原因

命名空间、类型、虚拟或接口成员的名称与编程语言中的保留关键字一致。

默认情况下，此规则仅查看外部可见的命名空间、类型和成员，但你可以配置可见性和符号类型。

规则说明

命名空间、类型以及虚拟和接口成员的标识符不应与面向公共语言运行时的语言所定义的关键字一致。 根据所用的语言和关键字，编译器错误和歧义会使库难以使用。

此规则检查以下语言中的关键字：

  • Visual Basic
  • C#
  • C++/CLI

不区分大小写的比较用于 Visual Basic 关键字，区分大小写的比较用于其他语言。

如何解决冲突

选择未显示在关键字列表中的名称。

何时禁止显示警告

如果确信标识符不会使 API 用户混淆，并且库可用于 .NET 中的所有可用语言，则可以禁止显示此规则的警告。

抑制警告

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

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

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

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

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

配置代码以进行分析

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

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

包含特定的 API 图面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

分析的符号类型

可配置此规则将分析的符号类型。 允许的值为：

  • Namespace
  • NamedType
  • Method
  • Property
  • Event
  • Parameter

用逗号 , 分隔多个值。 默认值包括前面列表中的所有符号类型。

dotnet_code_quality.CA1716.analyzed_symbol_kinds = Namespace, NamedType, Method, Property, Event