CA1704: Identificadores devem ser escritos corretamente

  • Artigo
Item Valor
RuleId CA1704
Categoria Microsoft.Naming
Alteração da falha Quebra

Causa

O nome de um identificador contém uma ou mais palavras não reconhecidas pela biblioteca do verificador ortográfico da Microsoft. Essa regra não verifica construtores ou membros nomeados especialmente, como obter e definir acessadores de propriedade.

Descrição da regra

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

  • Letras maiúsculas iniciam um novo token. Por exemplo, MyNameIsJoe tokeniza para "My", "Name", "Is", "Joe".

  • Para várias letras maiúsculas, a última letra maiúscula inicia um novo token. Por exemplo, GUIEditor tokeniza para "GUI", "Editor".

  • Apóstrofos à esquerda e à direita são removidos. Por exemplo, 'sender' tokeniza para "remetente".

  • Sublinhados significam o fim de um token e são removidos. Por exemplo, Hello_world tokeniza para "Olá", "mundo".

  • E comercializados inseridos são removidos. Por exemplo, for&mat tokeniza para "formato".

Idioma

Atualmente, o verificador ortográfico verifica apenas os dicionários de cultura baseados em inglês. Você pode alterar a cultura do projeto no arquivo de projeto, adicionando o elemento CodeAnalysisCulture.

Por exemplo:

<Project ...>
  <PropertyGroup>
    <CodeAnalysisCulture>en-AU</CodeAnalysisCulture>

Importante

Se você definir a cultura como algo diferente de uma cultura baseada em inglês, essa regra de análise de código será desabilitada silenciosamente.

Como corrigir violações

Para corrigir uma violação dessa regra, corrija a ortografia da palavra ou adicione a palavra a um dicionário personalizado.

Para adicionar palavras a um dicionário personalizado

Nomeie o arquivo XML do dicionário personalizado CustomDictionary.xml. Coloque o dicionário no diretório de instalação da ferramenta, no diretório do projeto ou no diretório associado à ferramenta no perfil do usuário (%USERPROFILE%\Application Data\...). Para saber como adicionar o dicionário personalizado a um projeto no Visual Studio, confira Como personalizar o Dicionário de Análise de Código.

  • Adicione palavras que não devem causar uma violação no caminho Dicionário/Palavras/Reconhecido.

  • Adicione palavras que devem causar uma violação no caminho Dicionário/Palavras/Irreconhecido.

  • Adicione palavras que devem ser sinalizadas como obsoletas no caminho Dictionary/Words/Deprecated. Consulte o tópico de regra relacionado CA1726: use termos preferenciais para obter mais informações.

  • Adicione exceções às regras de maiúsculas e minúsculas do acrônimo ao caminho Dictionary/Acronyms/CasingExceptions.

Veja 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

Suprima um aviso dessa regra somente se a palavra for intencionalmente incorreta e a palavra se aplicar a um conjunto limitado da biblioteca. Palavras escritas corretamente reduzem a curva de aprendizado necessária nas novas bibliotecas de software.

Confira também