Somente enums FlagsAttribute devem ter nomes no plural

Causa

O nome de uma enumeração visível externamente termina em uma palavra no plural e a enumeração não é marcada com o System.FlagsAttribute atributo.

Descrição da regra

Convenções de nomenclatura determinam que um nome no plural para uma enumeração indica que mais de um valor da enumeração pode ser especificado simultaneamente.The FlagsAttribute informa sistema autônomo compiladores que a enumeração deve ser tratada sistema autônomo um campo de bits que permite operações bit a bit na enumeração.

Se apenas um valor de uma enumeração pode ser especificado ao mesmo time, o nome da enumeração deve ser uma única palavra.Por exemplo, uma enumeração que define os dias da semana pode ser criada para uso em um aplicativo onde você pode especificar vários dias.Essa enumeração deve ter o FlagsAttribute e pode ser chamado 'Dias'. Uma enumeração semelhante que permite que um único dia seja especificado não terá o atributo e pode ser chamado 'Dia'.

Convenções de nomenclatura fornecem uma aparência comum para bibliotecas de destino o common linguagem tempo de execução.Isso reduz o time necessário para aprender uma nova biblioteca de software e aumenta a confiança do cliente que a biblioteca foi desenvolvida por uma pessoa com experiência em desenvolvimento de código gerenciado.

Como corrigir violações

Verifique o nome da enumeração uma única palavra ou adicionar a FlagsAttribute.

Quando suprimir avisos

É seguro eliminar um aviso a regra se o nome terminar em uma única palavra.

Regras relacionadas

Sinalizadores de enums devem ter nomes no plural

Marcar enums com FlagsAttribute

Não marque enums com FlagsAttribute

Consulte também

Referência

System.FlagsAttribute