CA1704: Bezeichner sollten korrekt geschrieben werden

Artikel
07/20/2011

TypeName	IdentifiersShouldBeSpelledCorrectly
CheckId	CA1704
Kategorie	Microsoft.Naming
Unterbrechende Änderung	Breaking

Ursache

Der Name eines Bezeichners enthält mindestens ein Wort, das von der Rechtschreibprüfung aus der Microsoft-Bibliothek nicht erkannt wird. Durch diese Regel werden keine Konstruktoren oder mit speziellen Namen versehene Member wie get- und set-Eigenschaftenaccessoren überprüft.

Regelbeschreibung

Durch diese Regel wird der Bezeichner in Token unterteilt und die Rechtschreibung der einzelnen Token überprüft. Der Analysealgorithmus führt die folgenden Transformationen aus:

Durch Großbuchstaben wird ein neues Token gestartet. Beispiel: MyNameIsJoe wird in die Token "My", "Name", "Is" und "Joe" unterteilt.
Wenn mehrere Großbuchstaben vorhanden sind, fängt das neue Token mit dem letzten Großbuchstaben an. Beispiel: GUIEditor wird in die Token "GUI" und "Editor" unterteilt.
Führende und nachfolgende Apostrophs werden entfernt. Beispiel: 'Absender' wird zum Token "Absender".
Unterstriche geben das Ende eines Tokens an und werden entfernt. Beispiel: Hello_world wird in die Token "Hello" und "world" unterteilt.
Eingebettete kaufmännische Und-Zeichen werden entfernt. Beispiel: for&mat wird zum Token "format".

Standardmäßig wird die englische Version (EN) der Rechtschreibprüfung verwendet. Derzeit sind keine anderen Sprachwörterbücher verfügbar.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, korrigieren Sie die Schreibung des Wortes oder fügen es einem benutzerdefinierten Wörterbuch mit dem Namen CustomDictionary.xml hinzu. Legen Sie das Wörterbuch im Installationsverzeichnis des Tools, im Projektverzeichnis oder im Verzeichnis ab, das dem Tool unter dem Profil des Benutzers (%USERPROFILE%\Anwendungsdaten\...) zugeordnet wurde. Um zu erfahren, wie das Benutzerwörterbuch einem Projekt in Visual Studio hinzugefügt wird, lesen Sie Gewusst wie: Anpassen des Codeanalysewörterbuchs

Fügen Sie Wörter, die keinen Verstoß verursachen sollen, unter dem Pfad Dictionary/Words/Recognized hinzu.
Fügen Sie Wörter, die einen Verstoß verursachen sollen, unter dem Pfad Dictionary/Words/Unrecognized hinzu.
Fügen Sie Wörter, die als veraltet gekennzeichnet werden sollen, unter dem Pfad Dictionary/Words/Deprecated hinzu. Weitere Informationen finden Sie im Thema zur verwandten Regel CA1726: Bevorzugte Begriffe verwenden.
Fügen Sie Ausnahmen für die Regeln zur Groß-/Kleinschreibung von Akronymen unter dem Pfad Dictionary/Acronyms/CasingExceptions hinzu.

Im Folgenden sehen Sie ein Beispiel für den Aufbau einer benutzerdefinierten Wörterbuchdatei.

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

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie eine Warnung dieser Regel nur dann, wenn das Wort absichtlich falsch geschrieben ist und sich auf einen Teilbereich der Bibliothek bezieht. Durch fehlerfreie Begriffe wird der Lernaufwand für neue Softwarebibliotheken verringert.

Siehe auch

Aufgaben

Gewusst wie: Anpassen des Codeanalysewörterbuchs

Freigeben über