Compartir a través de

CA1028: El almacenamiento de la enumeración debe ser de tipo Int32

  • Artículo
Propiedad Value
Identificador de la regla CA1028
Título El almacenamiento de la enumeración debe ser de tipo Int32
Categoría Diseño
La corrección es problemática o no problemática Problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

El tipo subyacente de una enumeración no es System.Int32.

De forma predeterminada, esta regla solo examina las enumeraciones visibles externamente, pero esto es configurable.

Descripción de la regla

Una enumeración es un tipo de valor que define un conjunto de constantes con nombre relacionadas. De forma predeterminada, el tipo de datos System.Int32 se utiliza para almacenar el valor constante. Aunque puede cambiar este tipo subyacente, no es necesario ni se recomienda en la mayoría de los escenarios. No se consigue un aumento significativo del rendimiento usando un tipo de datos menor que Int32. Si no puede utilizar el tipo de datos predeterminado, debe usar uno de los tipos enteros compatibles con Common Language System (CLS), Byte, Int16, Int32 o Int64 para asegurarse de que todos los valores de la enumeración se puedan representar en lenguajes de programación compatibles con CLS.

Cómo corregir infracciones

Para corregir una infracción de esta regla, a menos que existan problemas de tamaño o compatibilidad, use Int32. En situaciones en las que Int32 no sea lo suficientemente grande como para contener los valores, use Int64. Si la compatibilidad con versiones anteriores requiere un tipo de datos más pequeño, use Byte o Int16.

Cuándo suprimir las advertencias

Suprima una advertencia de esta regla solo si los problemas de compatibilidad con versiones anteriores lo requieren. En las aplicaciones, el no cumplimiento de esta regla normalmente no causa problemas. En el caso de las bibliotecas, en las que se requiere la interoperabilidad de lenguajes, el hecho de no cumplir esta regla podría afectar negativamente a los usuarios.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Configuración del código para analizar

Use la opción siguiente para configurar en qué partes del código base ejecutar esta regla.

Puede configurar esta opción solo para esta regla, para todas las reglas a las que se aplica o para todas las reglas de esta categoría (Diseño) a las que se aplica. Para más información, vea Opciones de configuración de reglas de calidad de código.

Incluir superficies de API específicas

Puede configurar en qué partes del código base ejecutar esta regla, en función de su accesibilidad. Por ejemplo, para especificar que la regla solo se debe ejecutar en la superficie de API no públicas, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Ejemplo

En el ejemplo siguiente se muestran dos enumeraciones que no utilizan el tipo de datos subyacente recomendado.

[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

En el ejemplo siguiente se corrige la infracción anterior cambiando el tipo de datos subyacente a 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

Consulte también