Konventionen für die Groß-/Kleinschreibung
Hinweis
Diese Inhalte wurden mit Genehmigung von Pearson Education, Inc. aus Framework Design Guidelines nachgedruckt: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition. Diese Ausgabe wurde 2008 veröffentlicht, und das Buch wurde seitdem in der dritten Ausgabe vollständig überarbeitet. Einige der Informationen auf dieser Seite sind möglicherweise veraltet.
Die Richtlinien in diesem Kapitel legen eine einfache Methode für die Verwendung der Groß-/Kleinschreibung dar, die bei konsistenter Anwendung Bezeichner für Typen, Member und Parameter leicht lesbar macht.
Regeln für die Groß-/Kleinschreibung von Bezeichnern
Um Wörter in einem Bezeichner zu unterscheiden, schreiben Sie den ersten Buchstaben jedes Worts im Bezeichner groß. Verwenden Sie Unterstriche weder zum Unterscheiden von Wörtern noch zu anderen Zwecken in Bezeichnern. Abhängig von der Verwendung des Bezeichners gibt es zwei geeignete Möglichkeiten für die Groß-/Kleinschreibung von Bezeichnern:
PascalCasing (Pascal-Schreibweise)
camelCasing (gemischte Groß-/Kleinschreibung)
Bei der PascalCasing-Konvention, die für alle Bezeichner außer Parameternamen verwendet wird, wird das erste Zeichen jedes Worts großgeschrieben (einschließlich Akronymen, die länger als zwei Buchstaben sind), wie in den folgenden Beispielen gezeigt:
PropertyDescriptor
HtmlTag
Ein Sonderfall sind Akronyme aus zwei Buchstaben, bei denen beide Buchstaben großgeschrieben werden, wie im folgenden Bezeichner zu sehen:
IOStream
Bei der camelCasing-Konvention, die nur für Parameternamen verwendet wird, wird das erste Zeichen jedes Worts, mit Ausnahme des ersten Worts, großgeschrieben, wie in den folgenden Beispielen gezeigt. Wie das Beispiel auch zeigt, werden Akronyme, die aus zwei Buchstaben bestehen und den Anfang eines camelCase-Bezeichners darstellen, mit zwei Kleinbuchstaben geschrieben.
propertyDescriptor
ioStream
htmlTag
✔️ VERWENDEN Sie PascalCasing für alle öffentlichen Member-, Typ- und Namespacenamen, die aus mehreren Wörtern bestehen.
✔️ VERWENDEN Sie camelCasing für Parameternamen.
In der folgenden Tabelle werden die Regeln für die Groß-/Kleinschreibung verschiedener Typen von Bezeichnern beschrieben.
| Bezeichner | Schreibweise | Beispiel |
|---|---|---|
| Namespace | Pascal | namespace System.Security { ... } |
| Typ | Pascal | public class StreamReader { ... } |
| Schnittstelle | Pascal | public interface IEnumerable { ... } |
| Methode | Pascal | public class Object { public virtual string ToString(); } |
| Eigenschaft | Pascal | public class String { public int Length { get; } } |
| Ereignis | Pascal | public class Process { public event EventHandler Exited; } |
| Feld | Pascal | public class MessageQueue { public static readonly TimeSpan InfiniteTimeout; } public struct UInt32 { public const Min = 0; } |
| Enumerationswert | Pascal | public enum FileMode { Append, ... } |
| Parameter | Groß-/Kleinschreibung gemischt | public class Convert { public static int ToInt32(string value); } |
Groß-/Kleinschreibung von zusammengesetzten Wörtern (Komposita) und allgemeinen Begriffen
Die meisten zusammengesetzten Begriffe werden hinsichtlich der Groß-/Kleinschreibung als Einzelwörter behandelt.
❌ Schreiben Sie NICHT jedes Wort in sogenannten zusammengesetzten Wörtern in geschlossener Form (Komposita) groß.
Es handelt sich dabei um zusammengesetzte Wörter, die als Einzelwort geschrieben werden, z. B. „endpoint“ (Endpunkt). Behandeln Sie ein Kompositum (zusammengesetztes Wort in geschlossener Form) hinsichtlich der Richtlinien für die Groß-/Kleinschreibung als einzelnes Wort. Verwenden Sie ein aktuelles Wörterbuch, um zu bestimmen, ob ein zusammengesetztes Wort in geschlossener Form geschrieben wird.
| Pascal | Groß-/Kleinschreibung gemischt | Not |
|---|---|---|
BitFlag |
bitFlag |
Bitflag |
Callback |
callback |
CallBack |
Canceled |
canceled |
Cancelled |
DoNot |
doNot |
Don't |
Email |
email |
EMail |
Endpoint |
endpoint |
EndPoint |
FileName |
fileName |
Filename |
Gridline |
gridline |
GridLine |
Hashtable |
hashtable |
HashTable |
Id |
id |
ID |
Indexes |
indexes |
Indices |
LogOff |
logOff |
LogOut |
LogOn |
logOn |
LogIn |
Metadata |
metadata |
MetaData, metaData |
Multipanel |
multipanel |
MultiPanel |
Multiview |
multiview |
MultiView |
Namespace |
namespace |
NameSpace |
Ok |
ok |
OK |
Pi |
pi |
PI |
Placeholder |
placeholder |
PlaceHolder |
SignIn |
signIn |
SignOn |
SignOut |
signOut |
SignOff |
UserName |
userName |
Username |
WhiteSpace |
whiteSpace |
Whitespace |
Writable |
writable |
Writeable |
Groß- und Kleinschreibung
Sprachen, die in der CLR ausgeführt werden können, müssen keine Unterstützung für Groß-/Kleinschreibung aufweisen, obwohl einige dies tun. Selbst wenn Ihre Sprache dies unterstützt, ist dies für andere Sprachen, die möglicherweise auf Ihr Framework zugreifen, nicht der Fall. Alle APIs, die extern zugänglich sind, können sich daher nicht auf Groß-/Kleinschreibung alleine verlassen, um zwischen zwei Namen im selben Kontext zu differenzieren.
❌ Setzen Sie NICHT voraus, dass alle Programmiersprachen die Groß-/Kleinschreibung beachten. Das sind sie nicht. Namen dürfen sich nicht nur durch die Groß-/Kleinschreibung unterscheiden.
Teile ©2005, 2009 Microsoft Corporation. Alle Rechte vorbehalten.
Nachdruck mit Genehmigung von Pearson Education, Inc aus Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition von Krzysztof Cwalina und Brad Abrams, veröffentlicht am 22. Oktober 2008 durch Addison-Wesley Professional als Teil der Microsoft Windows Development Series.