CA1707:标识符不应包含下划线

  • 项目
属性 值
规则 ID CA1707
标题 标识符不应包含下划线
类别 命名
修复是中断修复还是非中断修复 中断 - 在程序集上引发时

非中断 - 在类型参数上引发时
在 .NET 8 中默认启用 否

原因

标识符的名称包含下划线 (_) 字符。

规则说明

按照约定，标识符名称不包含下划线 (_) 字符。 该规则将检查命名空间、类型、成员和参数。

命名约定为面向公共语言运行时的库提供通用外观。 这缩短了新软件库的学习曲线，让客户更加相信该库是由拥有托管代码开发专业知识的人员开发的。

如何解决冲突

删除名称中的所有下划线字符。

何时禁止显示警告

请勿禁止显示有关生产代码的警告。 但对于测试代码，可安全地禁止显示此警告。

抑制警告

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

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

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

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

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

对于 Microsoft 代码中当前使用下划线且不能修改的已知方法，应禁止显示此规则。

配置代码以进行分析

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

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

包含特定的 API 图面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal