CA1717: apenas enums FlagsAttribute devem ter nomes plurais
TypeName |
OnlyFlagsEnumsShouldHavePluralNames |
CheckId |
CA1717 |
Categoria |
Microsoft.Naming |
Alteração Significativa |
Quebra |
Causa
O nome de uma enumeração externamente visível termina em uma palavra e plural a enumeração não é marcada com o atributo de FlagsAttribute .
Descrição da Regra
As convenções de nomenclatura ditam que um nome plural de uma enumeração indica que mais de um valor de enumeração pode ser especificado simultaneamente.FlagsAttribute informa a compiladores que a enumeração deve ser tratada como um campo de bits que permite operação bit a bit na enumeração.
Se apenas um valor de uma enumeração pode ser especificado em vez, o nome da enumeração deve ser uma palavra singular.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.Isso reduz o tempo necessário para obter uma nova biblioteca de software, e aumenta a confiança da biblioteca cliente que esteve desenvolvida por alguém que tiver experiência em código gerenciado desenvolvendo.
Como Corrigir Violações
Faça o nome da enumeração uma palavra singular ou adicionar FlagsAttribute.
Quando Suprimir Alertas
É seguro suprimir um aviso de regra se o nome termina em uma palavra singular.
Regras Relacionadas
CA1714: os enums de sinalizadores devem ter nomes plurais
CA1027: marcar enums com FlagsAttribute
CA2217: não marcar enums com FlagsAttribute