CA1704 : Les identificateurs doivent être correctement orthographiés

Article
08/10/2011

TypeName	IdentifiersShouldBeSpelledCorrectly
CheckId	CA1704
Catégorie	Microsoft.Naming
Modification avec rupture	Oui

Cause

Le nom d'un identificateur contient un ou plusieurs mots qui ne sont pas reconnus par la bibliothèque du correcteur orthographique Microsoft. Cette règle ne vérifie pas les constructeurs ou les membres avec une dénomination spéciale tels les accesseurs de propriété get et set.

Description de la règle

Cette règle analyse l'identificateur dans des 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. À titre d'exemple, MonNomestJosé régit sous forme de jeton "Mon", "Nom", "Est" et "José".
Dans le cas de plusieurs lettres majuscules, la dernière lettre majuscule commence par un nouveau jeton. À titre d'exemple, ÉditeurGUI régit sous forme de jeton "Éditeur" et "GUI".
Les apostrophes à gauche ou à droite sont supprimées. À titre d'exemple, 'expéditeur' régit sous forme de jeton "expéditeur".
Les traits de soulignement signifient la fin d'un jeton et sont supprimés. À titre d'exemple, Bonjour_monde régit sous forme de jeton "Bonjour" et "monde".
Les perluètes incorporées sont supprimées. À titre d'exemple, for&mat régit sous forme de jeton "format".

La version anglaise (en) du vérificateur d'orthographe est utilisée par défaut. Aucun autre dictionnaire de langue n'est actuellement disponible.

Comment corriger les violations

Pour résoudre une violation de cette règle, corrigez l'orthographe du mot ou ajoutez le mot à un dictionnaire personnalisé nommé CustomDictionary.xml. Placez ce dictionnaire dans le répertoire d'installation de l'outil, le répertoire du projet ou le répertoire associé à l'outil sous le profil de l'utilisateur (%USERPROFILE%\Application Data\...). Pour apprendre à ajouter le dictionnaire personnalisé à un projet dans Visual Studio, consultez Comment : personnaliser le dictionnaire d'analyse du code

Ajoutez les mots qui ne doivent pas provoquer de violation sous Dictionary/Words/Recognized path.
Ajoutez les mots qui doivent provoquer une violation sous Dictionary/Words/Unrecognized path.
Ajoutez les mots qui doivent être signalés comme obsolètes sous Dictionary/Words/Deprecated path. Consultez la rubrique associée CA1726 : Utilisez les termes par défaut pour plus d'informations.
Ajoutez les exceptions aux règles de casse des acronymes de Dictionary/Acronyms/CasingExceptions path.

Les éléments suivants sont un exemple de la structure d'un fichier de dictionnaire personnel.

   <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 uniquement un avertissement de cette règle si le mot est intentionnellement mal orthographié et que le mot s'applique à un jeu limité de la bibliothèque. Les mots épelés correctement réduisent la durée d'apprentissage requise pour les nouvelles bibliothèques de logiciels.