CA1714: os enums de sinalizadores devem ter nomes plurais

Artigo
06/08/2015

TypeName	FlagsEnumsShouldHavePluralNames
CheckId	CA1714
Categoria	Microsoft.Naming
Alteração Significativa	Quebra

Causa

Uma enumeração pública tem FlagsAttribute e seu nome não termina com “s”.

Descrição da Regra

Tipos que é marcado com FlagsAttribute tem nomes que são plural porque o atributo indica que mais de um valor pode ser especificado.Por exemplo, uma enumeração que define os dias da semana pode ser planejado para uso em um aplicativo onde você pode especificar vários dias.Esta enumeração deve ter FlagsAttribute e pode ser chamada “dias.Uma enumeração semelhante que permite que somente um nível dia seja especificado não teria o atributo, e pode ser chamada “dia”.

Convenções de nomenclatura dão uma aparência comum para bibliotecas que tem como foco o common language runtime.Isto reduz a curva de aprendizado que é necessária para novas bibliotecas de software, e aumenta confiança dos clientes de que a biblioteca foi desenvolvida por alguém que com experiência programar código gerenciado.

Como Corrigir Violações

Faça o nome da enumeração uma palavra plural, ou remover o atributo de FlagsAttribute se vários valores de enumeração são especificados simultaneamente.

Quando Suprimir Alertas

É seguro para suprimir uma violação se o nome é uma palavra plural mas não termina com “s”.Por exemplo, se a enumeração de vários dia que foi descrito anteriormente foi denominada “DaysOfTheWeek”, ou violaria a lógica da regra de sua mas não intencionais.Como violações devem ser suppressd.