CA1709: Identificadores devem ter maiúsculas e minúsculas corretas
Item | Valor |
---|---|
RuleId | CA1709 |
Categoria | Microsoft.Naming |
Alteração da falha | Quebra – quando gerado em assemblies, namespaces, tipos, membros e parâmetros. Sem quebra – quando gerada em parâmetros de tipo. |
Causa
O nome de um identificador não usa letras maiúsculas e minúsculas de forma correta.
- ou -
O nome de um identificador contém um acrônimo de duas letras, e a segunda letra é minúscula.
- ou -
O nome de um identificador contém um acrônimo de três ou mais letras maiúsculas.
Descrição da regra
As convenções de nomenclatura fornecem uma aparência comum para bibliotecas destinadas a Common Language Runtime. Essa consistência 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.
Por convenção, nomes de parâmetro usam maiúsculas, namespace e tipo, e nomes de membro usam maiúsculas Pascal. Em um nome com maiúsculas e minúsculas, a primeira letra é minúscula, e a primeira letra de qualquer palavra restante no nome é maiúscula. Exemplos de nomes com maiúsculas e minúsculas são packetSniffer
, ioFile
e fatalErrorCode
. Em um nome com maiúsculas e minúsculas em Pascal, a primeira letra é maiúscula, e a primeira letra de qualquer palavra restante no nome é maiúscula. Exemplos de nomes com maiúsculas e minúsculas em Pascal são PacketSniffer
, IOFile
e FatalErrorCode
.
Essa regra divide o nome em palavras com base no uso de maiúsculas e minúsculas e verifica as palavras de duas letras em uma lista de palavras comuns de duas letras, como "Em" ou "Me". Se uma correspondência não for encontrada, a palavra será considerada um acrônimo. Além disso, essa regra pressupõe que encontrou um acrônimo quando o nome contém quatro letras maiúsculas em uma linha ou três letras maiúsculas em uma linha no final do nome.
Por convenção, os acrônimos de duas letras usam todas as letras maiúsculas, e acrônimos de três ou mais caracteres usam maiúsculas e minúsculas pascal. Os exemplos a seguir usam essa convenção de nomenclatura: 'DB', 'CR', 'Cpa' e 'Ecma'. Os exemplos a seguir violam a convenção: 'Io', 'XML' e 'DoD', e para nomes não parâmetros, 'xp' e 'cpl'.
A 'ID' é especial para causar uma violação dessa regra. 'Id' não é um acrônimo, mas é uma abreviação para 'identificação'.
Como corrigir violações
Altere o nome para que ele tenha as maiúsculas e minúsculas corretas.
Quando suprimir avisos
É seguro suprimir esse aviso se você tiver suas próprias convenções de nomenclatura ou se o identificador representar um nome adequado, por exemplo, o nome de uma empresa ou uma tecnologia.
Você também pode adicionar termos, abreviações e acrônimos específicos a um dicionário personalizado de análise de código. Os termos especificados no dicionário personalizado não causarão violações dessa regra. Para obter mais informações, consulte Como personalizar o Dicionário de Code Analysis.
Regras relacionadas
CA1708: Identificadores devem ser diferentes em algo além das maiúsculas e minúsculas
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de