Freigeben über

CA1704: Bezeichner sollten korrekt geschrieben werden.

  • Artikel
Element Wert
RuleId CA1704
Category 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. Diese Regel überprüft weder Konstruktoren noch spezifisch benannte Member (z. B. get- und set-Eigenschaftenzugriffsmethoden).

Regelbeschreibung

Diese Regel analysiert den Bezeichner in Token und überprüft die Schreibweise jedes Tokens. Der Analysealgorithmus führt die folgenden Transformationen durch:

  • Mit jedem Großbuchstaben beginnt ein neues Token. „MyNameIsJoe“ wird beispielsweise in die Token „My“, „Name“, „Is“ und „Joe“ transformiert.

  • Bei mehreren Großbuchstaben beginnt mit dem letzten Großbuchstaben ein neues Token. „GUIEditor“ wird beispielsweise in die Token „GUI“ und „Editor“ transformiert.

  • Vorangestellte und nachfolgende Apostrophe werden entfernt. 'sender' wird beispielsweise in das Token „sender“ transformiert.

  • Unterstriche kennzeichnen das Ende eines Tokens und werden entfernt. „Hello_world“ wird beispielsweise in die Token „Hello“ und „world“ transformiert.

  • Eingebettete &-Zeichen werden entfernt. „for&mat“ wird beispielsweise in das Token „format“ transformiert.

Sprache

Die Rechtschreibprüfung erfolgt derzeit nur auf Grundlage englischsprachiger Wörterbücher. Sie können die Sprachkultur Ihres Projekts in der Projektdatei ändern, indem Sie das CodeAnalysisCulture-Element hinzufügen.

Beispiel:

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

Wichtig

Wenn Sie die Sprachkultur auf eine andere als eine auf Englisch basierende Kultur festlegen, wird diese Codeanalyseregel ohne Hinweis deaktiviert.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, korrigieren Sie die Schreibweise des Worts, oder fügen Sie das Wort einem benutzerdefinierten Wörterbuch hinzu.

Hinzufügen von Wörtern zu einem benutzerdefinierten Wörterbuch

Benennen Sie die XML-Datei des benutzerdefinierten Wörterbuchs CustomDictionary.xml. Platzieren Sie das Wörterbuch im Installationsverzeichnis des Tools, im Projektverzeichnis oder im Verzeichnis, das dem Tool unter dem Profil der Benutzer*innen zugeordnet ist (%USERPROFILE%\Application Data\...). Informationen dazu, wie Sie einem Projekt in Visual Studio das benutzerdefinierte Wörterbuch hinzufügen, finden Sie unter Anpassen des Code Analysis-Wörterbuchs.

  • Fügen Sie Wörter hinzu, die unter dem Pfad Dictionary/Words/Recognized keinen Verstoß verursachen sollen.

  • Fügen Sie Wörter hinzu, die unter dem Pfad Dictionary/Words/Unrecognized einen Verstoß verursachen sollen.

  • Fügen Sie Wörter hinzu, die unter dem Pfad Dictionary/Words/Deprecated als veraltet gekennzeichnet werden sollen. Weitere Informationen finden Sie im Artikel CA1726: Verwenden bevorzugter Begriffe zur entsprechenden Regel.

  • Fügen Sie den Groß- und Kleinschreibungsregeln für Akronyme unter dem Pfad Dictionary/Acronyms/CasingExceptions Ausnahmen hinzu.

Im Folgenden sehen Sie ein Beispiel für die Struktur einer Datei für ein benutzerdefiniertes Wörterbuch:

<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 durch diese Regel nur, wenn das Wort absichtlich falsch geschrieben ist und das Wort auf einen begrenzten Teil der Bibliothek angewendet wird. Richtig geschriebene Wörter reduzieren die Lernkurve, die für neue Softwarebibliotheken erforderlich ist.

Weitere Informationen