CA1028:枚举存储应为 Int32

  • 项目
属性 值
规则 ID CA1028
标题 枚举存储应为 Int32
类别 设计
修复是中断修复还是非中断修复 重大
在 .NET 8 中默认启用 否

原因

枚举的基础类型不是 System.Int32。

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

规则说明

枚举是一种值类型，它定义一组相关的已命名常数。 默认情况下，System.Int32 数据类型用于存储常量值。 虽然你可以更改此基础类型，但对于大多数情况，既不需要，也不建议你这样做。 使用小于 Int32 的数据类型不会显著提高性能。 如果无法使用默认数据类型，则应使用某种符合公共语言规范 (CLS) 的整型类型，例如 Byte、Int16、Int32 或 Int64，以确保枚举的所有值都可以用符合 CLS 的编程语言表示。

如何解决冲突

若要解决此规则的冲突，除非存在大小或兼容性问题，否则请使用 Int32。 对于 Int32 不够大而无法保存值的情况，请使用 Int64。 如果向后兼容性要求较小的数据类型，请使用 Byte 或 Int16。

何时禁止显示警告

仅当后向兼容性问题需要时，才禁止显示此规则的警告。 在应用程序中，未能遵守此规则通常不会导致问题。 在需要语言互操作性的库中，未能遵守此规则可能会对用户造成不利影响。

抑制警告

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

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

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

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

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

配置代码以进行分析

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

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

包含特定的 API 图面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

示例

下面的示例演示了两个不使用建议的基础数据类型的枚举。

[Flags]
public enum Days : uint
{
    None = 0,
    Monday = 1,
    Tuesday = 2,
    Wednesday = 4,
    Thursday = 8,
    Friday = 16,
    All = Monday | Tuesday | Wednesday | Thursday | Friday
}

public enum Color : sbyte
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

<Flags()>
Public Enum Days As UInteger
    None = 0
    Monday = 1
    Tuesday = 2
    Wednesday = 4
    Thursday = 8
    Friday = 16
    All = Monday Or Tuesday Or Wednesday Or Thursday Or Friday
End Enum

Public Enum Color As SByte
    None = 0
    Red = 1
    Orange = 3
    Yellow = 4
End Enum

下面的示例将基础数据类型更改为 Int32 来解决先前的冲突。

[Flags]
public enum Days : int
{
    None = 0,
    Monday = 1,
    Tuesday = 2,
    Wednesday = 4,
    Thursday = 8,
    Friday = 16,
    All = Monday | Tuesday | Wednesday | Thursday | Friday
}

public enum Color : int
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

<Flags()>
Public Enum Days As Integer
    None = 0
    Monday = 1
    Tuesday = 2
    Wednesday = 4
    Thursday = 8
    Friday = 16
    All = Monday Or Tuesday Or Wednesday Or Thursday Or Friday
End Enum

Public Enum Color As Integer
    None = 0
    Red = 1
    Orange = 3
    Yellow = 4
End Enum

另请参阅