CA1704: Identificadores devem ser escritos corretamente

Artigo
08/08/2011

TypeName	IdentifiersShouldBeSpelledCorrectly
CheckId	CA1704
<strong>Categoria</strong>	Microsoft.Naming
Alteração significativa	Quebrando

Causa

O nome de um identificador contém uma ou mais palavras que não são reconhecidas pela biblioteca do verificador ortográfico do Microsoft. Esta regra não verificar membros nomeados em especial, como, por exemplo, get ou construtores e definir os assessores da propriedade.

Descrição da regra

Esta regra analisa o identificador em tokens e verifica a ortografia de cada token. O algoritmo de análise executa as transformações seguintes:

Letras maiúsculas iniciar um novo token. Por exemplo, MyNameIsJoe divide "Meu", "Nome", "É", "Joe".
Para várias letras maiúsculas, a última letra maiúscula inicia um novo token. Por exemplo, GUIEditor divide a "Martins", "Editor".
À esquerda e apóstrofos são removidos. Por exemplo, 'Remetente' divide a "remetente".
Sublinhados significam o final de um token em são removidos. Por exemplo, Hello_world divide para "Hello", "world".
União incorporado é removido. Por exemplo, para & passe-partout divide "Formatar".

Por padrão, é usada a versão em inglês (en) o verificador ortográfico. Não há dicionários de idiomas estão disponíveis atualmente.

Como corrigir violações

Para corrigir uma violação desta regra, corrigir a ortografia da palavra ou adicionar a palavra ao dicionário personalizado chamado CustomDictionary.xml. Coloque o dicionário no diretório de instalação da ferramenta, o diretório do projeto, ou no diretório que está associado com a ferramenta de perfil do usuário (%USERPROFILE%\Application Data\...). Para aprender a adicionar ao dicionário personalizado a um projeto em Visual Studio, consulte Como: Personalizar o dicionário de análise de código

Adicione palavras que não devem causar uma violação no caminho de palavras/dicionário/reconhecido.
Adicione palavras que devem causar uma violação no caminho do dicionário/palavras/não reconhecido.
Adicione palavras que devem ser sinalizadas como obsoleto no caminho de palavras/dicionário/obsoleto. Consulte o tópico relacionado regra CA1726: Termos de uso preferidopara obter mais informações.
Adicione exceções às regras de capitalização acrônimo para o caminho de acrônimos/dicionário/CasingExceptions.

A seguir é um exemplo da estrutura de um arquivo de dicionário personalizado.

   <Dictionary>
      <Words>
         <Unrecognized>
            <Word>cb</Word>
         </Unrecognized>
         <Recognized>
            <Word>stylesheet</Word>
            <Word>GotDotNet</Word>
         </Recognized>
         <Deprecated>
            <Term PreferredAlternate="EnterpriseServices">ComPlus</Term>
         </Deprecated>
      </Words>
      <Acronyms>
         <CasingExceptions>
            <Acronym>CJK</Acronym>
            <Acronym>Pi</Acronym>
         </CasingExceptions>
      </Acronyms>
   </Dictionary>

Quando suprimir avisos

Elimina um aviso esta regra somente se a palavra é intencionalmente incorreta e o word aplica a um conjunto limitado de biblioteca. Corretamente as palavras escritas de reduzem a curva de aprendizado é necessária para novas bibliotecas de software.