Partilhar via


CA1709: Identificadores devem ser minúsculas corretamente

TypeName

IdentifiersShouldBeCasedCorrectly

CheckId

CA1709

<strong>Categoria</strong>

Microsoft.Naming

Alteração significativa

Quebrando - quando gerado em assemblies, namespaces, tipos, membros e parâmetros.

Não-separável - quando acionado em parâmetros de tipo genérico.

Causa

O nome de um identificador não é causado corretamente.

- 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

Convenções de nomenclatura fornecem um aspecto familiar a bibliotecas que se destinam ao uso com a common language runtime. Isso reduz a curva de aprendizado que é necessário para novas bibliotecas de software e aumenta a confiança do cliente que a biblioteca foi desenvolvida por alguém que tenha experiência em desenvolvimento de código gerenciado.

Por convenção, os nomes de parâmetro usam camel casing; os nomes de espaço para nome, tipo e membro usam Pascal casing. Um nome concatenados, a primeira letra é minúscula e a primeira letra das palavras restantes no nome é em letras maiúsculas. Exemplos de nomes concatenados são "packetSniffer", "ioFile" e "fatalErrorCode". Um nome de minúsculas de Pascal, a primeira letra é maiúscula e a primeira letra das palavras restantes no nome é em letras maiúsculas. Exemplos de nomes de minúsculas de Pascal são "packetsniffer", "iofile" e "fatalerrorcode".

Esta regra divide o nome de palavras com base em que o uso de maiúsculas e verifica as palavras de duas letras em uma lista de palavras de duas letras comuns, como "In" ou "Meu". Se uma correspondência não for encontrada, a palavra é considerada um acrônimo. Além disso, essa regra pressupõe encontrou um acrônimo quando o nome contém quatro letras maiúsculas em uma linha de um ou três letras maiúsculas em uma linha no final do nome.

Por convenção, acrônimos de duas letras usam letras maiúsculas e acrônimos de três ou mais caracteres Pascal casing. Os exemplos seguintes 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 os nomes de nonparameter, 'xp' e o 'Painel de controle'.

'ID' é causado em especial, para causar uma violação desta regra. ' ID' não é um acrônimo, mas é uma abreviação de 'identificação'.

Como corrigir violações

Altere o nome de forma que ele é minúsculas corretamente.

Quando suprimir avisos

É seguro suprimir este aviso, se você tiver seus próprio convenções de nomenclatura, ou se o identificador representa um nome apropriado, por exemplo, o nome de uma empresa ou uma tecnologia.

Você também pode adicionar termos específicos, abreviações e acrônimos que a um dicionário personalizado de análise de código. Termos especificados no dicionário personalizado não irá causar violações desta regra. Para mais informações, consulte: Como: Personalizar o dicionário de análise de código.

Regras relacionadas

CA1708: Identificadores devem diferir por mais de caso