CA1714: Las enumeraciones Flags deberían tener nombres en plural

Artículo
02/19/2013

Nombre de tipo	FlagsEnumsShouldHavePluralNames
Identificador de comprobación	CA1714
Categoría	Microsoft.Naming
Cambio problemático	Sí

Motivo

Una enumeración pública tiene System.FlagsAttribute y su nombre no termina en 's'.

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 usarse en una aplicación en la que se pueden especificar varios días.Esta enumeración debería tener FlagsAttribute y podría denominarse 'Días'.Una enumeración similar que permite especificar sólo un día no tendría el atributo y se podría denominar 'Día'.

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

Cómo corregir infracciones

Cambie el nombre de la enumeración a una palabra en plural o quite el atributo FlagsAttribute si no se deben especificar varios valores de enumeración simultáneamente.

Cuándo suprimir advertencias

Se puede suprimir una infracción de forma segura si el nombre es una palabra en plural pero no termina en 's'.Por ejemplo, si la enumeración de varios días descrita anteriormente se denominara 'DíasDeLaSemana', esto infringiría la lógica de la regla pero no su intención.Este tipo de infracciones debería suprimirse.