Sinalizadores de enums devem ter nomes no plural

Causa

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

Descrição da regra

Tipos marcados com FlagsAttribute ter nomes que estão no plural porque o atributo indica que pode ser especificado mais de um valor. 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 a curva de aprendizado necessária para novas bibliotecas 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 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 descrita anteriormente foram denominada 'DaysOfTheWeek', isso violaria lógica da regra, mas não sua intenção.Essas violações devem ser suppressd.

Regras relacionadas

Marcar enums com FlagsAttribute

Não marque enums com FlagsAttribute

Consulte também

Referência

System.FlagsAttribute