Benennungsregeln
Benennungsregeln unterstützen die Einhaltung der Benennungskonventionen der .NET-Entwurfsrichtlinien.
In diesem Abschnitt
Regel | Beschreibung |
---|---|
CA1700: Verwenden Sie nicht den Namen 'Reserviert' für Enum-Werte | Bei dieser Regel wird davon ausgegangen, dass ein Enumerationsmemmemm, das einen Namen enthält, der "reserviert" enthält, derzeit nicht verwendet wird, sondern ein Platzhalter ist, der in einer zukünftigen Version umbenannt oder entfernt werden soll. Das Umbenennen oder Entfernen eines Mitglieds ist eine bedeutende Änderung. |
CA1707: Bezeichner dürfen keine Unterstriche enthalten | Bezeichnernamen enthalten standardmäßig nicht das Unterstrichzeichen (_). Diese Regel überprüft Namespaces, Typen, Member und Parameter. |
CA1708: Bezeichner sollten sich nicht nur durch die Groß-/Kleinschreibung unterscheiden. | Bezeichner für Namespaces, Typen, Member und Parameter dürfen sich nicht nur durch die Groß-/Kleinschreibung unterscheiden, weil Sprachen, die auf die Common Language Runtime abzielen, nicht zwischen Groß- und Kleinschreibung unterscheiden müssen. |
CA1710: Bezeichner sollten das richtige Suffix haben | Standardmäßig verfügen die Namen von Typen, die bestimmte Basistypen erweitern oder bestimmte Schnittstellen implementieren oder von diesen Typen abgeleitete Typen über ein Suffix verfügen, das dem Basistyp oder der Schnittstelle zugeordnet ist. |
CA1711: Bezeichner sollten kein falsches Suffix haben | Standardmäßig sollten nur die Namen von Typen, die bestimmte Basistypen erweitern oder bestimmte Schnittstellen oder Typen implementieren, die von diesen Typen abgeleitet sind, mit bestimmten reservierten Suffixen enden. Andere Typnamen sollten diese reservierten Suffixe nicht verwenden. |
CA1712: Enum-Werte nicht mit dem Typnamen voranstellen | Namen von Enumerationsmitgliedern werden dem Typnamen nicht vorangestellt, da typbezogene Informationen von Entwicklungstools erwartet werden. |
CA1713: Ereignisse sollten kein Before- oder After-Präfix aufweisen. | Der Name eines Ereignisses beginnt mit "Before" oder "After". Um verwandte Ereignisse zu benennen, die in einer bestimmten Sequenz ausgelöst werden, verwenden Sie die aktuelle oder vergangene Zeichenfolge, um die relative Position in der Folge von Aktionen anzugeben. |
CA1714: Flags-Enumerationen sollten Pluralnamen aufweisen. | Eine öffentliche Enumeration weist das System.FlagsAttribute-Attribut auf, und ihr Name endet nicht in "s". Typen, die mit FlagsAttribute gekennzeichnet sind, weisen Pluralnamen auf, da das Attribut angibt, dass mehrere Werte angegeben werden können. |
CA1715: Bezeichner sollten das korrekte Präfix haben. | Der Name einer extern sichtbaren Schnittstelle beginnt nicht mit einem Großbuchstaben "I". Der Name eines generischen Typparameters für einen extern sichtbaren Typ oder eine Methode beginnt nicht mit einem Großbuchstaben "T". |
CA1716: Bezeichner sollten nicht mit Schlüsselwörtern übereinstimmen | Ein Namespacename oder ein Typname entspricht einem reservierten Schlüsselwort in einer Programmiersprache. Bezeichner für Namespaces und Typen sollten nicht mit Schlüsselwörtern übereinstimmen, die von Sprachen definiert werden, die auf die Common Language Runtime abzielen. |
CA1717: Nur FlagsAttribute-Enumerationen sollten Pluralnamen aufweisen. | Benennungskonventionen diktieren, dass ein Pluralname für eine Enumeration angibt, dass mehrere Werte der Enumeration gleichzeitig angegeben werden können. |
CA1720: Bezeichner dürfen keine Typnamen enthalten | Der Name eines Parameters in einem extern sichtbaren Element enthält einen Datentypnamen, oder der Name eines extern sichtbaren Elements enthält einen sprachspezifischen Datentypnamen. |
CA1721: Eigenschaftennamen sollten nicht mit get-Methoden übereinstimmen | Der Name eines öffentlichen oder geschützten Members beginnt mit "Get" und stimmt in anderer Hinsicht mit dem Namen einer öffentlichen oder geschützten Eigenschaft überein. "Get"-Methoden und -Eigenschaften sollten Namen haben, die ihre Funktion eindeutig unterscheiden. |
CA1724: Typnamen sollten nicht mit Namespaces übereinstimmen | Typnamen sollten nicht mit den Namen von .NET-Namespaces übereinstimmen. Verstöße gegen diese Regel können die Benutzerfreundlichkeit der Bibliothek verringern. |
CA1725: Parameternamen sollten mit der Basisdeklaration übereinstimmen | Die konsistente Benennung von Parametern in einer Überschreibungshierarchie erhöht die Verwendbarkeit von Methodenüberschreibungen. Ein Parametername in einer abgeleiteten Methode, die sich von dem Namen in der Basisdeklaration unterscheidet, kann Verwirrung darüber verursachen, ob die Methode eine Außerkraftsetzung der Basismethode oder eine neue Überladung der Methode ist. |
CA1727: Verwenden Sie PascalCase für benannte Platzhalter | Verwenden Sie PascalCase für benannte Platzhalter in der Protokollnachrichtenvorlage. |
Zusammenarbeit auf GitHub
Die Quelle für diesen Inhalt finden Sie auf GitHub, wo Sie auch Issues und Pull Requests erstellen und überprüfen können. Weitere Informationen finden Sie in unserem Leitfaden für Mitwirkende.