CA1714:Flags 枚举应采用复数形式的名称

  • 项目
属性 值
规则 ID CA1714
标题 Flags 枚举应采用复数形式的名称
类别 命名
修复是中断修复还是非中断修复 重大
在 .NET 8 中默认启用 否

原因

枚举具有 System.FlagsAttribute，并且其名称不是以“s”结尾。

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

规则说明

用 FlagsAttribute 标记的类型具有复数形式的名称，因为该特性指明可以指定多个值。 例如，定义一周中各天的枚举可能适用于指定多天的应用程序。 此枚举应该具有 FlagsAttribute，并且可称为“Days”。 类似的枚举如果只允许指定一天，则不具有该属性，可以称为“Day”。

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

如何解决冲突

将枚举的名称设为复数，如果不应同时指定多个枚举值，请删除 FlagsAttribute 属性。

何时禁止显示警告

如果名称是复数形式，但不以“s”结尾，则可以安全地禁止显示冲突。 例如，如果前面描述的多天枚举名为“DaysOfTheWeek”，虽然这不是它的本意，但也违反了规则的逻辑。 应该禁止显示此类冲突。

抑制警告

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

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

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

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

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

配置代码以进行分析

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

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

包含特定的 API 图面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

另请参阅