CA1704 : L'orthographe des identificateurs doit être correcte

  • Article
Élément Valeur
ID de la règle CA1704
Category Microsoft.Naming
Modification avec rupture Rupture

Cause

Le nom d'un identificateur contient un ou plusieurs mots qui ne sont pas reconnus par la bibliothèque du vérificateur d'orthographe Microsoft. Cette règle ne vérifie pas les constructeurs ou les membres nommés spéciaux, tels que les accesseurs de propriété get et set.

Description de la règle

Cette règle analyse l’identificateur en jetons et vérifie l’orthographe de chaque jeton. L’algorithme d’analyse effectue les transformations suivantes :

  • Les lettres majuscules démarrent un nouveau jeton. Par exemple, MyNameIsJoe segmente en « My », « Name », « Is », « Joe ».

  • Pour plusieurs lettres majuscules, la dernière lettre majuscule démarre un nouveau jeton. Par exemple, GUIEditor segmente en « GUI », « Editor ».

  • Les apostrophes de début et de fin sont supprimées. Par exemple, « sender » segmente en « sender ».

  • Les traits de soulignement signifient la fin d’un jeton et sont supprimés. Par exemple, Hello_world segmente en « Hello », « world ».

  • Les esperluettes incorporés sont supprimées. Par exemple, for&mat segmente en « format ».

Langage

Actuellement, le vérificateur orthographique effectue uniquement la vérification par rapport aux dictionnaires de culture basée sur l’anglais. Vous pouvez modifier la culture de votre projet dans le fichier projet en ajoutant l’élément CodeAnalysisCulture.

Par exemple :

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

Important

Si vous définissez une culture autre qu’une culture basée sur l’anglais, cette règle d’analyse du code est désactivée sans avertissement particulier.

Comment corriger les violations

Pour corriger une violation de cette règle, corrigez l’orthographe du mot ou ajoutez le mot à un dictionnaire personnalisé.

Pour ajouter des mots à un dictionnaire personnalisé

Nommez le fichier XML du dictionnaire personnalisé CustomDictionary.xml. Placez le dictionnaire dans le répertoire d’installation de l’outil, le répertoire du projet ou dans le répertoire associé à l’outil sous le profil de l’utilisateur (%USERPROFILE%\Application Data\...). Pour savoir comment ajouter le dictionnaire personnalisé à un projet dans Visual Studio, consultez Guide pratique : personnaliser le dictionnaire d’analyse du code.

  • Ajoutez des mots qui ne doivent pas provoquer de violation sous le chemin Dictionnaire/Mots/Reconnus.

  • Ajoutez des mots qui ne doivent pas provoquer de violation sous le chemin Dictionnaire/Mots/Non reconnus.

  • Ajoutez des mots qui doivent être marqués comme obsolètes sous le chemin Dictionnaire/Mots/Dépréciés. Pour plus d’informations, consultez la rubrique relative aux règles CA1726 : Utiliser les termes préférés pour plus d’informations.

  • Ajoutez des exceptions aux règles de casse d’acronyme au chemin Dictionnaire/Acronymes/Exceptions de casse.

Voici un exemple de structure d’un fichier de dictionnaire personnalisé :

<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>

Quand supprimer les avertissements

Supprimez un avertissement de cette règle uniquement si le mot est intentionnellement mal orthographié et que le mot s’applique à un ensemble limité de la bibliothèque. Les mots correctement orthographiés réduisent la courbe d’apprentissage requise pour apprendre de nouvelles bibliothèques de logiciels.

Voir aussi