CA1714: Las enumeraciones Flags deben tener nombres en plural

  • Artículo
Propiedad Value
Identificador de la regla CA1714
Título Las enumeraciones Flags deben tener nombres en plural
Categoría Nomenclatura
La corrección es problemática o no problemática Problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

Una enumeración tiene el atributo System.FlagsAttribute y su nombre no termina en "s".

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

Descripción de la regla

Los tipos marcados con FlagsAttribute tienen nombres en plural porque el atributo indica que se puede especificar más de un valor. Por ejemplo, una enumeración que define los días de la semana podría estar pensada para usarse en una aplicación donde se pueden especificar varios días. Esta enumeración debe tener el atributo FlagsAttribute y podría llamarse "Days" (Días). Una enumeración similar que permite especificar un solo día no tendría el atributo y podría llamarse "Day" (Día).

Las convenciones de nomenclatura proporcionan una apariencia común para las bibliotecas destinadas a Common Language Runtime. Esto reduce la curva de aprendizaje necesaria para las nuevas bibliotecas de software y aumenta la confianza del cliente respecto a que la biblioteca se haya desarrollado por parte de un especialista en desarrollo de código administrado.

Cómo corregir infracciones

Haga que el nombre de la enumeración sea una palabra plural o quite el atributo FlagsAttribute si no se deben especificar varios valores de enumeración de forma simultánea.

Cuándo suprimir las advertencias

Es seguro suprimir una infracción si el nombre es una palabra en plural, pero no termina en "s". Por ejemplo, si la enumeración de varios días que se ha descrito anteriormente se denominara "DaysOfTheWeek" (DíasDeLaSemana), esto infringiría la lógica de la regla, pero no su intención. Dichas infracciones deben suprimirse.

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

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.CA1714.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 (Nomenclatura) 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

Consulte también