CA1720:标识符不应包含类型名称

  • 项目
属性 值
规则 ID CA1720
标题 标识符不应包含类型名称
类别 命名
修复是中断修复还是非中断修复 重大
在 .NET 8 中默认启用 否

原因

成员中的参数名称包含数据类型名称。

-或-

成员的名称包含语言特定的数据类型名称。

默认情况下，此规则仅查看外部可见的成员，但这可配置。

规则说明

参数和成员的名称更好地用于传达其含义而不是描述其类型，类型描述通常由开发工具提供。 对于成员的名称，如果必须使用数据类型名称，请使用与语言无关的名称，而不要使用语言特定的名称。 例如，请使用与语言无关的数据类型名称 Int32，而不要使用 C# 类型名称 int。

参数或成员名称中的每个离散标记都会对照以下语言特定的数据类型名称进行检查（不区分大小写）：

  • Bool
  • WChar
  • Int8
  • UInt8
  • Short
  • UShort
  • int
  • UInt
  • Integer
  • UInteger
  • Long
  • ULong
  • 无符号
  • 有符号
  • Float
  • Float32
  • Float64

此外，参数的名称还会对照以下与语言无关的数据类型名称进行检查（不区分大小写）：

  • 对象
  • 布尔
  • Char
  • 字符串
  • SByte
  • Byte
  • UByte
  • Int16
  • UInt16
  • Int32
  • UInt32
  • Int64
  • UInt64
  • IntPtr
  • Ptr
  • 指针
  • UInptr
  • UPtr
  • UPointer
  • Single
  • Double
  • 小数
  • GUID

如何解决冲突

如果针对参数触发：

将参数名称中的数据类型标识符替换为一个可更好地描述其含义的词或更通用的词，如“value”。

如果针对成员触发：

将成员名称中的语言特定数据类型标识符替换为一个可更好地描述其含义的词、与语言无关的等效词或更通用的词，如“value”。

何时禁止显示警告

如果偶尔使用基于类型的参数和成员名称，则可禁止显示警告。 但对于新开发，没有任何已知情况应该禁止显示此规则的警告。 对于以前发布的库，可能有必要禁止显示此规则的警告。

抑制警告

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

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

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

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

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

配置代码以进行分析

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

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

包含特定的 API 图面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal