CA1069:枚举不得具有重复值
属性 | 值 |
---|---|
规则 ID | CA1069 |
标题 | 枚举不得具有重复值 |
类别 | 设计 |
修复是中断修复还是非中断修复 | 重大 |
在 .NET 9 中默认启用 | 作为建议 |
原因
枚举具有多个成员,这些成员显式分配有相同常数值。
规则说明
每个枚举成员都应具有唯一的常数值,或者为其显式分配枚举中的前一个成员以指示共享值的明确意图。 例如:
enum E
{
Field1 = 1,
AnotherNameForField1 = Field1, // This is fine
Field2 = 2,
Field3 = 2, // CA1069: This is not fine. Either assign a different constant value or 'Field2' to indicate explicit intent of sharing value.
}
此规则有助于捕获在以下场景中引入的功能性 bug:
- 意外键入错误:用户意外地为多个成员键入了相同的常数值。
- 复制粘贴错误:用户复制了一个现有成员定义,然后重命名了该成员,但忘记更改值。
- 合并多个分支中的解决方案:在不同分支中添加了具有不同名称但有相同值的新成员。
如何解决冲突
若要解决冲突,请分配新的唯一常数值,或分配枚举中的前一个成员以指示共享同一值的明确意图。 例如,以下代码片段显示了与此规则的冲突,以及解决冲突的几种方法:
enum E
{
Field1 = 1,
AnotherNameForField1 = Field1, // This is fine
Field2 = 2,
Field3 = 2, // CA1069: This is not fine. Either assign a different constant value or 'Field2' to indicate explicit intent of sharing value.
}
enum E
{
Field1 = 1,
AnotherNameForField1 = Field1, // This is fine
Field2 = 2,
Field3 = 3, // This is now fine
}
enum E
{
Field1 = 1,
AnotherNameForField1 = Field1, // This is fine
Field2 = 2,
Field3 = Field2, // This is also fine
}
何时禁止显示警告
请勿禁止显示此规则的冲突。