CA1701: Palavras compostas de cadeia de caracteres de recurso devem ter maiúsculas e minúsculas corretas

  • Artigo
Item Valor
RuleId CA1701
Categoria Microsoft.Naming
Alteração da falha Sem interrupção

Causa

Uma cadeia de caracteres de recurso contém uma palavra composta que não parece estar com as letras maiúsculas e minúsculas corretas.

Observação

Esta regra foi preterida. Para obter mais informações, confira Regras preteridas.

Descrição da regra

Cada palavra na cadeia de caracteres de recurso é dividida em tokens baseados nas letras maiúsculas e minúsculas. Cada combinação contígua de dois tokens é verificada pela biblioteca do verificador ortográfico da Microsoft. Se reconhecidas, as palavras produzirão uma violação da regra. Entre os exemplos de palavras compostas que causam violação estão "CheckSum" e "MultiPart", que devem ser grafadas como "Checksum" e "Multipart", respectivamente. Devido ao uso comum anterior, várias exceções são incorporadas à regra, e várias palavras simples são sinalizadas, como "Toolbar" e "Filename", que devem ser grafadas como duas palavras distintas. Neste exemplo, "ToolBar" e "FileName" seriam sinalizados.

As convenções de nomenclatura fornecem uma aparência comum para bibliotecas destinadas a 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

Altere a palavra para que ela tenha as maiúsculas e minúsculas corretas.

Alterar o idioma do dicionário

Por padrão, a versão em inglês (en) do verificador ortográfico é usada. Se quiser alterar o idioma do verificador ortográfico, você poderá fazer isso adicionando um dos seguintes atributos ao arquivo AssemblyInfo.cs ou AssemblyInfo.vb:

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.

Quando suprimir avisos

É seguro suprimir um aviso dessa regra se ambas as partes da palavra composta são reconhecidas pelo dicionário ortográfico e a intenção é usar duas palavras.

Você também pode adicionar palavras compostas a um dicionário personalizado para o verificador ortográfico. Palavras no dicionário personalizado não causam violações. Para obter mais informações, consulte Como personalizar o Dicionário de Code Analysis.

Confira também