- 22.10.2008
- 2 Minuten zu lesen
-
-
K -
n -
B -
D -
n -
+10
-
Die Leitlinien in diesem Kapitel stellen eine einfache Methode zur Verwendung von Groß- und Kleinschreibung dar, die, wenn sie konsequent angewendet wird, die Bezeichner für Typen, Mitglieder und Parameter leicht lesbar macht.
Kapitalisierungsregeln für Bezeichner
Um Wörter in einem Bezeichner zu unterscheiden, schreiben Sie den ersten Buchstaben jedes Wortes im Bezeichner groß. Verwenden Sie keine Unterstriche zur Unterscheidung von Wörtern und auch sonst nirgendwo in Bezeichnern. Es gibt zwei geeignete Arten, Bezeichner groß zu schreiben, je nach Verwendung des Bezeichners:
-
PascalCasing
-
camelCasing
Die PascalCasing-Konvention, die für alle Bezeichner außer Parameternamen verwendet wird, schreibt den ersten Buchstaben jedes Wortes groß (einschließlich Akronyme mit mehr als zwei Buchstaben), wie in den folgenden Beispielen gezeigt:
PropertyDescriptorHtmlTag
Ein Sonderfall sind zweibuchstabige Akronyme, bei denen beide Buchstaben großgeschrieben werden, wie im folgenden Bezeichner gezeigt:
IOStream
Die camelCasing-Konvention, die nur für Parameternamen verwendet wird, schreibt den ersten Buchstaben jedes Wortes groß, außer dem ersten Wort, wie in den folgenden Beispielen gezeigt. Wie das Beispiel auch zeigt, werden zweibuchstabige Akronyme, die mit einem camel-cased Bezeichner beginnen, beide kleingeschrieben.
propertyDescriptorioStreamhtmlTag
✔️ DO use PascalCasing for all public member, type, and namespace names consisting of multiple words.
✔️ DO use camelCasing for parameter names.
Die folgende Tabelle beschreibt die Großschreibregeln für verschiedene Arten von Bezeichnern.
| Bezeichner | Schreibweise | Beispiel |
|---|---|---|
| Namensraum | 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; } |
| Enum-Wert | Pascal | public enum FileMode { Append, ... } |
| Parameter | Camel | public class Convert { public static int ToInt32(string value); } |
Großschreibung von zusammengesetzten Wörtern und allgemeinen Begriffen
Die meisten zusammengesetzten Begriffe werden für die Großschreibung wie einzelne Wörter behandelt.
❌ Bei so genannten zusammengesetzten Wörtern in geschlossener Form werden die einzelnen Wörter NICHT großgeschrieben.
Dies sind zusammengesetzte Wörter, die als ein einziges Wort geschrieben werden, wie z. B. Endpunkt. Für die Zwecke der Richtlinien für die Groß- und Kleinschreibung behandeln Sie ein zusammengesetztes Wort in geschlossener Form als ein einzelnes Wort. Verwenden Sie ein aktuelles Wörterbuch, um festzustellen, ob ein zusammengesetztes Wort in geschlossener Form geschrieben ist.
| Pascal | Camel | Nicht |
|---|---|---|
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ß-/Kleinschreibung
Sprachen, die auf der CLR laufen können, müssen Groß-/Kleinschreibung nicht unterstützen.sensitivity, obwohl einige dies tun. Selbst wenn Ihre Sprache sie unterstützt, tun es andere Sprachen, die auf Ihr Framework zugreifen könnten, nicht. Alle APIs, auf die von außen zugegriffen wird, können sich daher nicht allein auf die Groß- und Kleinschreibung verlassen, um zwischen zwei Namen im gleichen Kontext zu unterscheiden.
❌ Gehen Sie NICHT davon aus, dass alle Programmiersprachen die Groß- und Kleinschreibung unterstützen. Sie sind es nicht. Namen können sich nicht allein durch Groß- und Kleinschreibung unterscheiden.
Ausschnitte © 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 von Addison-Wesley Professional als Teil der Microsoft Windows Development Series.
Siehe auch
- Framework Design Guidelines
- Naming Guidelines