CA1027: Marcar enumeraciones con FlagsAttribute

  • Artículo
Propiedad Value
Identificador de la regla CA1027
Título Marcar enumeraciones con FlagsAttribute
Categoría Diseño
La corrección es problemática o no problemática Poco problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

Los valores de una enumeración son potencias de dos, o bien combinaciones de otros valores que se definen en la enumeración, y el atributo System.FlagsAttribute no está presente. Para reducir los falsos positivos, esta regla no notifica una infracción en las enumeraciones que tienen valores contiguos.

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. Aplique FlagsAttribute a una enumeración cuando se pueda combinar con sentido sus constantes con nombre. Por ejemplo, considere una enumeración de los días de la semana en una aplicación que realiza un seguimiento de los recursos del día que están disponibles. Si la disponibilidad de cada recurso se codifica mediante la enumeración que tiene FlagsAttribute presente, se puede representar cualquier combinación de días. Sin el atributo, solo se puede representar un día de la semana.

En el caso de los campos que almacenan enumeraciones combinables, los valores de enumeración individuales se tratan como grupos de bits en el campo. Por este motivo, estos campos a veces se denominan campos de bits. Si quiere combinar los valores de enumeración para el almacenamiento en un campo de bits, utilice los operadores condicionales booleanos. Para probar un campo de bits a fin de determinar si un valor de enumeración específico está presente, utilice los operadores lógicos booleanos. Para que un campo de bits almacene y recupere correctamente los valores de enumeración combinados, cada valor que se define en la enumeración debe ser una potencia de dos. De lo contrario, los operadores lógicos booleanos no podrán extraer los valores de enumeración individuales almacenados en el campo.

Cómo corregir infracciones

Para corregir una infracción de esta regla, agregue FlagsAttribute a la enumeración.

Cuándo suprimir las advertencias

Suprima una advertencia de esta regla si no quiere que los valores de enumeración sean combinables.

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 CA1027
// The code that's violating the rule is on this line.
#pragma warning restore CA1027

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.CA1027.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, DaysEnumNeedsFlags es una enumeración que cumple los requisitos para usar FlagsAttribute, pero no lo tiene. La enumeración ColorEnumShouldNotHaveFlag no tiene valores que sean potencias de dos, pero especifica FlagsAttribute incorrectamente. Esto infringe la regla CA2217: No marcar enumeraciones con FlagsAttribute.

// Violates rule: MarkEnumsWithFlags.
public enum DaysEnumNeedsFlags
{
    None = 0,
    Monday = 1,
    Tuesday = 2,
    Wednesday = 4,
    Thursday = 8,
    Friday = 16,
    All = Monday | Tuesday | Wednesday | Thursday | Friday
}

// Violates rule: DoNotMarkEnumsWithFlags.
[FlagsAttribute]
public enum ColorEnumShouldNotHaveFlag
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

Consulte también