CA1717: Solo las enumeraciones FlagsAttribute deben tener nombres en plural

  • Artículo
Propiedad Value
Identificador de la regla CA1717
Título Solo las enumeraciones FlagsAttribute 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

El nombre de una enumeración finaliza con una palabra plural y la enumeración no está marcada con el atributo System.FlagsAttribute.

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

Descripción de la regla

Las convenciones de nomenclatura establecen que un nombre en plural para una enumeración indica que se pueden especificar varios valores de enumeración al mismo tiempo. FlagsAttribute indica a los compiladores que la enumeración se debe tratar como un campo de bits que habilita las operaciones bit a bit en la enumeración.

Si solo se puede especificar un valor de una enumeración a la vez, el nombre de la enumeración debe ser una palabra en singular. 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 el tiempo necesario para aprender una nueva biblioteca de software y aumenta la confianza del cliente en que la biblioteca la ha desarrollada alguien con experiencia en desarrollo de código administrado.

Cómo corregir infracciones

Establezca el nombre de la enumeración en una palabra en singular o agregue FlagsAttribute.

Cuándo suprimir las advertencias

Es seguro suprimir una advertencia de la regla si el nombre termina con una palabra en singular.

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

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.CA1717.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