Konventionen für die Groß-/Kleinschreibung
Aktualisiert: November 2007
Viele Benennungskonventionen betreffen die Groß-/Kleinschreibung von Bezeichnern. Beachten Sie unbedingt, dass die Common Language Runtime (CLR) sowohl Sprachen unterstützt, in denen die Groß-/Kleinschreibung beachtet wird, als auch Sprachen, in denen sie nicht beachtet wird. Die in diesem Thema beschriebenen Konventionen für die Groß-/Kleinschreibung vereinfachen für Entwickler das Verständnis und die Verwendung einer Bibliothek.
Formate der Groß-/Kleinschreibung
Die folgenden Begriffe beschreiben verschiedene Verfahren für die Groß-/Kleinschreibung von Bezeichnern.
Pascal-Schreibweise
Der erste Buchstabe des Bezeichners und der erste Buchstabe jedes weiteren verketteten Wortes werden groß geschrieben. Sie können die Pascal‑Schreibweise für Bezeichner mit drei oder mehr Zeichen verwenden. Beispiel:
BackColor
Kamel-Schreibweise
Der erste Buchstabe des Bezeichners wird klein geschrieben, der erste Buchstabe jedes weiteren verketteten Wortes wird groß geschrieben. Beispiel:
backColor
Großbuchstaben
Alle Buchstaben des Bezeichners werden groß geschrieben. Beispiel:
IO
Regeln für die Groß-/Kleinschreibung von Bezeichnern
Wenn ein Bezeichner aus mehreren Wörtern besteht, verwenden Sie keine Trennzeichen, z. B. Unterstriche ("_") oder Bindestriche ("-"), zwischen den Wörtern. Geben Sie stattdessen den Anfang jedes Worts durch die Groß-/Kleinschreibung an.
Die folgenden Richtlinien enthalten die allgemeinen Regeln für Bezeichner.
Verwenden Sie die Pascal-Schreibweise für alle Namen öffentlicher Member, Typen und Namespaces, die aus mehreren Wörtern bestehen.
Beachten Sie, dass diese Regel nicht für Instanzfelder gilt. Aus Gründen, die in den Entwurfsrichtlinien für Member erläutert werden, sollten Sie keine öffentlichen Instanzfelder verwenden.
Verwenden Sie für Parameternamen die Kamel-Schreibweise.
In der folgenden Tabelle werden die Regeln für die Groß-/Kleinschreibung zusammengefasst und Beispiele für die verschiedenen Bezeichnertypen dargestellt.
Bezeichner |
Schreibweise |
Beispiel |
|---|---|---|
Klasse |
Pascal |
AppDomain |
Enumerationstyp |
Pascal |
ErrorLevel |
Enumerationswerte |
Pascal |
FatalError |
Ereignis |
Pascal |
ValueChanged |
Ausnahmeklasse |
Pascal |
WebException |
Schreibgeschütztes statisches Feld |
Pascal |
RedValue |
Schnittstelle |
Pascal |
IDisposable |
Methode |
Pascal |
ToString |
Namespace |
Pascal |
System.Drawing |
Parameter |
Camel |
typeName |
Eigenschaft |
Pascal |
BackColor |
Regeln für die Groß-/Kleinschreibung von Akronymen
Ein Akronym wird aus den Anfangsbuchstaben der Wörter eines Begriffs oder einer Phrase gebildet. Beispielsweise ist HTML ein Akronym für Hypertext Markup Language. Schließen Sie Akronyme nur in Bezeichner ein, wenn sie allgemein bekannt sind und ihre Bedeutung verstanden wird. Akronyme unterscheiden sich von Abkürzungen darin, dass mit einer Abkürzung nur ein einzelnes Wort abgekürzt wird. Beispielsweise ist ID eine Abkürzung von identifier. Im Allgemeinen sollten in Bibliotheksnamen keine Abkürzungen verwendet werden.
Tipp
Die beiden Abkürzungen, die in Bezeichnern verwendet werden können, sind ID und OK. In Bezeichnern mit Pascal-Schreibweise müssen sie Id und Ok geschrieben werden. Wenn sie als das erste Wort in einem Bezeichner mit Kamel-Schreibweise verwendet werden, müssen sie id bzw. ok geschrieben werden.
Die Groß-/Kleinschreibung von Akronymen hängt von der Länge des Akronyms ab. Alle Akronyme bestehen aus mindestens zwei Zeichen. In diesen Richtlinien wird ein Akronym, das aus genau zwei Zeichen besteht, als kurzes Akronym betrachtet. Ein Akronym aus drei oder mehr Zeichen ist ein langes Akronym.
Die folgenden Richtlinien geben die richtige Groß-/Kleinschreibung für kurze und lange Akronyme an. Die Regeln für die Groß-/Kleinschreibung von Bezeichnern haben Vorrang vor den Regeln für die Groß-/Kleinschreibung von Akronymen.
Verwenden Sie für beide Zeichen von Akronymen aus zwei Zeichen Großbuchstaben, außer beim ersten Wort eines Bezeichners in Kamel-Schreibweise.
Eine Eigenschaft mit dem Namen DBRate ist ein Beispiel für ein kurzes Akronym (DB), das als erstes Wort eines Bezeichners in Pascal-Schreibweise verwendet wird. Ein Parameter mit dem Namen ioChannel ist ein Beispiel für ein kurzes Akronym (IO), das als erstes Wort eines Bezeichners in Kamel-Schreibweise verwendet wird.
Verwenden Sie nur für das erste Zeichen von Akronymen aus mindestens drei Zeichen Großbuchstaben, außer beim ersten Wort eines Bezeichners in Kamel-Schreibweise.
Eine Klasse mit dem Namen XmlWriter ist ein Beispiel für ein langes Akronym, das als erster Bestandteil eines Bezeichners in Kamel-Schreibweise verwendet wird. Ein Parameter mit dem Namen htmlReader ist ein Beispiel für ein langes Akronym, das als erstes Wort eines Bezeichners in Kamel-Schreibweise verwendet wird.
Verwenden Sie niemals Großbuchstaben für Akronyme am Anfang eines Bezeichners in Kamel-Schreibweise, unabhängig von der Länge des Akronyms.
Ein Parameter mit dem Namen xmlStream ist ein Beispiel für ein langes Akronym (xml), das als erstes Wort eines Bezeichners in Kamel-Schreibweise verwendet wird. Ein Parameter mit dem Namen dbServerName ist ein Beispiel für ein kurzes Akronym (db), das als erstes Wort eines Bezeichners in Kamel-Schreibweise verwendet wird.
Regeln für die Groß-/Kleinschreibung von zusammengesetzten Wörtern und allgemeinen Begriffen
Verwenden Sie nicht für jedes Wort in zusammengesetzten Wörtern mit geschlossener Form große Anfangsbuchstaben. Hierbei handelt es sich um zusammengesetzte Wörter, die als einzelnes Wort geschrieben werden, z. B. "Endpunkt".
Beispielsweise ist hashtable ein zusammengesetztes Wort in geschlossener Form, das als einzelnes Wort behandelt und entsprechend geschrieben werden muss. In Pascal-Schreibweise lautet es Hashtable und in Kamel-Schreibweise hashtable. Um zu bestimmen, ob ein Wort ein zusammengesetztes Wort in geschlossener Form ist, sehen Sie in einem aktuellen Wörterbuch nach.
Die folgende Liste enthält einige allgemeine Begriffe, die keine zusammengesetzten Wörter in geschlossener Form sind. Das Wort wird in Pascal-Schreibweise und dahinter in Klammern in Kamel-Schreibweise dargestellt.
BitFlag (bitFlag)
FileName (fileName)
LogOff (logOff)
LogOn (logOn)
SignIn (signIn)
SignOut (signOut)
UserName (userName)
WhiteSpace (whiteSpace)
Berücksichtigung der Groß-/Kleinschreibung
Die Richtlinien für die Groß-/Kleinschreibung sollen lediglich die Lesbarkeit und das Erkennen von Bezeichnern erleichtern. Die Groß-/Kleinschreibung ist keine Möglichkeit, um Namenskonflikte zwischen Bibliothekselementen zu vermeiden.
Gehen Sie nicht davon aus, dass die Groß-/Kleinschreibung in allen Programmiersprachen berücksichtigt wird. Dies ist nicht der Fall. Namen können nicht ausschließlich anhand der Groß-/Kleinschreibung unterschieden werden.
Copyright für einzelne Teile 2005 Microsoft Corporation. Alle Rechte vorbehalten.
Copyright für einzelne Teile Addison-Wesley Corporation. Alle Rechte vorbehalten.
Weitere Informationen zu Entwurfsrichtlinien finden Sie im Buch "Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries" von Krzysztof Cwalina und Brad Abrams, veröffentlicht von Addison-Wesley, 2005.