CA1709: Bei Bezeichnern sollte die Groß-/Kleinschreibung beachtet werden.

Element	Wert
RuleId	CA1709
Category	Microsoft.Naming
Unterbrechende Änderung	Breaking: Bei Auslösung für Assemblys, Namespaces, Typen, Member und Parameter. Nicht Breaking: Bei Auslösung für generische Typparameter.

Ursache

Die Groß-/Kleinschreibung des Namens eines Bezeichners ist nicht richtig.

- oder -

Der Name eines Bezeichners enthält ein Akronym aus zwei Buchstaben, und der zweite Buchstabe ist ein Kleinbuchstabe.

- oder -

Der Name eines Bezeichners enthält ein Akronym aus drei oder mehr Großbuchstaben.

Regelbeschreibung

Durch Benennungskonventionen erhalten Bibliotheken, die auf die Common Language Runtime abzielen, ein einheitliches Erscheinungsbild. Durch diese Konsistenz wird der Lernaufwand für neue Softwarebibliotheken verringert. Zudem wird das Kundenvertrauen dahingehend gestärkt, dass die Bibliothek von einem erfahrenen Entwickler für verwalteten Code erstellt wurde.

Gemäß der Konvention werden Parameternamen in Kamel-Schreibweise verfasst, für Namespace-, Typ- und Membernamen wird die Pascal-Schreibweise verwendet. Bei einem Namen in Camel-Case-Schreibweise ist der erste Buchstabe ein Kleinbuchstabe, und der erste Buchstabe jedes verbleibenden Worts im Namen ist ein Großbuchstabe. Beispiele für Namen in Camel-Case-Schreibweise sind packetSniffer, ioFile und fatalErrorCode. Bei einem Namen in Pascal-Schreibweise ist der erste Buchstabe ein Großbuchstabe, und der erste Buchstabe jedes verbleibenden Worts im Namen ist ein Großbuchstabe. Beispiele für Namen in Pascal-Schreibweise sind PacketSniffer, IOFile und FatalErrorCode.

Diese Regel teilt den Namen auf Grundlage der Groß- und Kleinschreibung in Wörter auf und überprüft alle Wörter aus zwei Buchstaben anhand einer Liste gängiger Wörter mit zwei Buchstaben, z. B. „In“ oder „Da“. Wenn keine Übereinstimmung gefunden wird, wird davon ausgegangen, dass es sich bei dem Wort um ein Akronym handelt. Darüber hinaus geht diese Regel davon aus, dass sie ein Akronym gefunden hat, wenn der Name entweder vier Großbuchstaben hintereinander oder drei Großbuchstaben hintereinander am Ende des Namens enthält.

Gemäß der Konvention verwenden Zwei-Buchstaben-Akronyme durchgängig Großbuchstaben, und Akronyme aus drei oder mehr Buchstaben verwenden Pascal-Schreibweise. In den folgenden Beispielen wird diese Benennungskonvention verwendet: „DB“, „CR“, „Cpa“ und „Ecma“. Die folgenden Beispiele verstoßen gegen die Konvention: „Io“, „XML“ und „DoD“ sowie für Nicht-Parameternamen „xp“ und „cpl“.

„ID“ ist speziell geschrieben, um einen Verstoß gegen diese Regel zu erzielen. „Id“ ist kein Akronym, sondern eine Abkürzung für „Identifizierung“.

Behandeln von Verstößen

Ändern Sie den Namen so, dass die Groß-/Kleinschreibung korrekt ist.

Wann sollten Warnungen unterdrückt werden?

Sie können diese Warnung gefahrlos unterdrücken, wenn Sie eigene Benennungskonventionen haben, oder wenn der Bezeichner einen Eigennamen darstellt, z. B. den Namen eines Unternehmens oder einer Technologie.

Sie können auch bestimmte Begriffe, Abkürzungen und Akronyme einem benutzerdefinierten Codeanalyse-Wörterbuch hinzufügen. Im benutzerdefinierten Wörterbuch angegebene Begriffe führen nicht zu Verstößen gegen diese Regel. Weitere Informationen finden Sie unter Gewusst wie: Anpassen des Codeanalyse-Wörterbuchs.

Verwandte Regeln

CA1708: Bezeichner sollten sich nicht nur durch die Groß-/Kleinschreibung unterscheiden.