CA1714: Sinalizadores enums devem ter nomes plural

Artigo
08/08/2011

TypeName	FlagsEnumsShouldHavePluralNames
CheckId	CA1714
<strong>Categoria</strong>	Microsoft.Naming
Alteração significativa	Quebrando

Causa

Uma enumeração pública tem o System.FlagsAttribute e seu nome não termina em '.

Descrição da regra

Tipos que são marcados com FlagsAttribute têm nomes que estão no 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 servir para uso em um aplicativo onde você pode especificar vários dias. Essa enumeração deve ter o FlagsAttribute e podem ser denominados 'Dias'. Uma enumeração semelhante que permite que um único dia seja especificado não tem o atributo e poderia ser chamado de 'Dia'.

Convenções de nomenclatura fornecem um aspecto familiar a bibliotecas que se destinam ao uso com a common language runtime. Isso reduz a curva de aprendizado que é necessário para novas bibliotecas de software e aumenta a confiança do cliente que a biblioteca foi desenvolvida por alguém que tenha experiência em desenvolvimento de código gerenciado.

Como corrigir violações

Verifique o nome da enumeração de uma palavra no plural ou remover o FlagsAttribute atributo se vários valores de enumeração não devem ser especificados simultaneamente.

Quando suprimir avisos

É seguro suprimir a uma violação se o nome é uma palavra no plural, mas não termina em do '. Por exemplo, se a enumeração de vários dias foi descrita anteriormente foram nomeada 'daysoftheweek', isso violaria a lógica da regra, mas não a sua intenção. Essas violações devem ser suppressd.