CA1707: Identificadores não devem conter sublinhados
| Property | Valor |
|---|---|
| ID da regra | CA1707 |
| Título | Identificadores não devem conter sublinhados |
| Categoria | Nomenclatura |
| Correção interruptiva ou sem interrupção | Interruptiva: quando gerada em assemblies Sem interrupção: quando gerada em parâmetros de tipo |
| Habilitado por padrão no .NET 8 | Não |
Causa
O nome de um identificador contém o caractere sublinhado (_).
Descrição da regra
Por convenção, os nomes de identificador não contêm o caractere de sublinhado (_). A regra verifica namespaces, tipos, membros e parâmetros.
As convenções de nomenclatura fornecem uma aparência comum para bibliotecas destinadas ao 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 com experiência no desenvolvimento de código gerenciado.
Como corrigir violações
Remova todos os caracteres sublinhados do nome.
Quando suprimir avisos
Não suprima os avisos do código de produção. No entanto, é seguro suprimir esse aviso para o código de teste.
Suprimir um aviso
Para suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem a fim de desabilitar e, em seguida, reabilitar a regra.
#pragma warning disable CA1707
// The code that's violating the rule is on this line.
#pragma warning restore CA1707
Para desabilitar a regra em um arquivo, uma pasta ou um projeto, defina a severidade como none no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.CA1707.severity = none
Para obter mais informações, consulte Como suprimir avisos de análise de código.
Para métodos conhecidos no código da Microsoft que atualmente usam um sublinhado e não podem ser modificados, a regra deverá ser suprimida.
Configurar código para analisar
Use a opção a seguir para configurar em quais partes da base de código essa regra deve ser executada.
Você pode configurar essa opção apenas para essa regra, para todas as regras às quais ela se aplica ou para todas as regras nessa categoria (Nomenclatura) às quais ela se aplica. Para saber mais, confira Opções de configuração de regra de qualidade de código.
Incluir superfícies de API específicas
É possível configurar em quais partes da base de código essa regra deverá ser executada, com base na acessibilidade. Por exemplo, para especificar que a regra deverá ser executada apenas na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig no projeto:
dotnet_code_quality.CAXXXX.api_surface = private, internal
