CA1717: Solo las enumeraciones FlagsAttribute deberían tener nombres en pluralCA1717: Only FlagsAttribute enums should have plural names

TypeNameTypeName OnlyFlagsEnumsShouldHavePluralNamesOnlyFlagsEnumsShouldHavePluralNames
Identificador de comprobaciónCheckId CA1717CA1717
CategoríaCategory Microsoft.NamingMicrosoft.Naming
Cambio problemáticoBreaking Change ProblemáticoBreaking

MotivoCause

El nombre de una enumeración visible externamente termina en una palabra en plural y la enumeración no está marcada con el System.FlagsAttribute atributo.The name of an externally visible enumeration ends in a plural word and the enumeration is not marked with the System.FlagsAttribute attribute.

Descripción de la reglaRule description

Convenciones de nomenclatura dictan que un nombre plural para una enumeración indica que se puede especificar más de un valor de la enumeración al mismo tiempo.Naming conventions dictate that a plural name for an enumeration indicates that more than one value of the enumeration can be specified simultaneously. El FlagsAttribute indica a los compiladores que la enumeración debe tratarse como un campo de bits que habilita las operaciones bit a bit en la enumeración.The FlagsAttribute tells compilers that the enumeration should be treated as a bit field that enables bitwise operations on the enumeration.

Si solo puede especificarse un valor de enumeración a la vez, el nombre de la enumeración debe ser una palabra en singular.If only one value of an enumeration can be specified at a time, the name of the enumeration should be a singular word. Por ejemplo, una enumeración que define los días de la semana esté destinada para su uso en una aplicación que se pueden especificar varios días.For example, an enumeration that defines the days of the week might be intended for use in an application where you can specify multiple days. Esta enumeración debe tener el FlagsAttribute y podría denominarse 'Días'.This enumeration should have the FlagsAttribute and could be called 'Days'. Una enumeración similar que permite sólo un día que se especifique no tendría el atributo y podría ser denominada 'Day'.A similar enumeration that allows only a single day to be specified would not have the attribute, and could be called 'Day'.

Las convenciones de nomenclatura proporcionan una apariencia común para las bibliotecas destinadas a Common Language Runtime.Naming conventions provide a common look for libraries that target the common language runtime. Esto reduce el tiempo que se requiere para obtener información sobre una nueva biblioteca de software y aumenta la confianza del cliente que la biblioteca fue desarrollada por alguien que tenga experiencia en desarrollo de código administrado.This reduces the time that is required to learn a new software library, and increases customer confidence that the library was developed by someone who has expertise in developing managed code.

Cómo corregir infraccionesHow to fix violations

Cambie el nombre de la enumeración de una palabra en singular o agregar el FlagsAttribute.Make the name of the enumeration a singular word or add the FlagsAttribute.

Cuándo Suprimir advertenciasWhen to suppress warnings

Es seguro suprimir una advertencia de la regla si el nombre termina en una palabra en singular.It is safe to suppress a warning from the rule if the name ends in a singular word.

CA1714: Las enumeraciones Flags deberían tener nombres en pluralCA1714: Flags enums should have plural names

CA1027: Marcar enumeraciones con FlagsAttributeCA1027: Mark enums with FlagsAttribute

CA2217: No marcar enumeraciones con FlagsAttributeCA2217: Do not mark enums with FlagsAttribute

Vea tambiénSee also