CA1714: Enumerações de sinalizador devem ter nomes no pluralCA1714: Flags enums should have plural names

ValorValue
ID da regraRule ID CA1714CA1714
CategoriaCategory NomenclaturaNaming
A correção está sendo interrompida ou não está sendo interrompidaFix is breaking or non-breaking QuebraBreaking

CausaCause

Uma enumeração tem o System.FlagsAttribute e seu nome não termina em ' s'.An enumeration has the System.FlagsAttribute and its name does not end in 's'.

Por padrão, essa regra só examina enumerações visíveis externamente, mas isso é configurável.By default, this rule only looks at externally visible enumerations, but this is configurable.

Descrição da regraRule description

Os tipos marcados com FlagsAttribute têm nomes que são plural porque o atributo indica que mais de um valor pode ser especificado.Types that are marked with FlagsAttribute have names that are plural because the attribute indicates that more than one value can be specified. Por exemplo, uma enumeração que define os dias da semana pode ser destinada a uso em um aplicativo em que você pode especificar vários dias.For example, an enumeration that defines the days of the week might be intended for use in an application where you can specify multiple days. Essa enumeração deve ter FlagsAttribute e pode ser chamada ' Days '.This enumeration should have the FlagsAttribute and could be called 'Days'. Uma enumeração semelhante que permite que apenas um único dia seja especificado não teria o atributo e poderia ser chamada ' Day '.A similar enumeration that allows only a single day to be specified would not have the attribute, and could be called 'Day'.

As convenções de nomenclatura fornecem uma aparência comum para as bibliotecas direcionadas ao Common Language Runtime.Naming conventions provide a common look for libraries that target the common language runtime. Isso reduz a curva de aprendizado necessária para novas bibliotecas de software e aumenta a confiança do cliente de que a biblioteca foi desenvolvida por alguém que tenha experiência no desenvolvimento de código gerenciado.This reduces the learning curve that is required for new software libraries, and increases customer confidence that the library was developed by someone who has expertise in developing managed code.

Como corrigir violaçõesHow to fix violations

Torne o nome da enumeração uma palavra plural ou remova o FlagsAttribute atributo se vários valores de enumeração não devem ser especificados simultaneamente.Make the name of the enumeration a plural word, or remove the FlagsAttribute attribute if multiple enumeration values should not be specified simultaneously.

Quando suprimir avisosWhen to suppress warnings

É seguro suprimir uma violação se o nome for uma palavra plural, mas não terminar em ' s'.It is safe to suppress a violation if the name is a plural word but does not end in 's'. Por exemplo, se a enumeração de vários dias que foi descrita anteriormente era denominada ' DaysOfTheWeek ', isso violaria a lógica da regra, mas não sua intenção.For example, if the multiple-day enumeration that was described previously were named 'DaysOfTheWeek', this would violate the logic of the rule but not its intent. Essas violações devem ser suprimidas.Such violations should be suppressed.

Configurar o código para analisarConfigure code to analyze

Use a opção a seguir para configurar em quais partes de sua base de código executar essa regra.Use the following option to configure which parts of your codebase to run this rule on.

Você pode configurar essa opção apenas para essa regra, para todas as regras ou para todas as regras nesta categoria (nomenclatura).You can configure this option for just this rule, for all rules, or for all rules in this category (Naming). Para obter mais informações, consulte Opções de configuração de regra de qualidade de código.For more information, see Code quality rule configuration options.

Incluir superfícies de API específicasInclude specific API surfaces

Você pode configurar em quais partes de sua base de código executar essa regra, com base em sua acessibilidade.You can configure which parts of your codebase to run this rule on, based on their accessibility. Por exemplo, para especificar que a regra deve ser executada somente na superfície da API não pública, adicione o seguinte par chave-valor a um arquivo . editorconfig em seu projeto:For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Consulte tambémSee also