C # -Namenskonventionen für Akronyme

Wenn ich in Bezug auf die C # -Nennung für Akronyme eine Bibliothek im Zusammenhang mit der Windows-API schreibe, gibt es eine starke Konvention in Bezug auf WindowsApi oder WindowsAPI oder handelt es sich nur um eine persönliche Präferenz?

Es gibt eine Konvention, die für alle Akronyme, die länger als 2 Zeichen sind, den Anfangsbuchstaben in Großbuchstaben und den Rest in Kleinbuchstaben angibt. Daher HttpContextund ClientID.

" Framework Design Guidelines " 2. Auflage von Krzysztof Cwalina und Brad Abrams S. 40-42

3.1.2 Großschreibung von Akronymen

Schreiben Sie beide Zeichen in Großbuchstaben, mit Ausnahme des ersten Wortes eines Kamelkennzeichens.

System.IO
public void StartIO(Stream ioStream)

DO nutzt nur das erste Zeichen der Abkürzungen mit drei oder mehr Zeichen, außer dem ersten Wort eines Kamel gefassten Identifikator.

System.Xml
public void ProcessHtmlTag(string htmlTag)

Großschreiben Sie KEINE Zeichen von Akronymen, unabhängig von ihrer Länge, am Anfang einer Kennung in Kamelhülle.

Überprüfen Sie die offiziellen Dokumente von Microsoft zu Benennungsrichtlinien und Großschreibungskonventionen :

Um Wörter in einem Bezeichner zu unterscheiden, schreiben Sie den ersten Buchstaben jedes Wortes im Bezeichner groß. Verwenden Sie keine Unterstriche, um Wörter oder irgendwo in Bezeichnern zu unterscheiden. Abhängig von der Verwendung des Bezeichners gibt es zwei geeignete Möglichkeiten, Bezeichner groß zu schreiben:

• PascalCasing
• camelCasing

Die PascalCasing- Konvention, die für alle Bezeichner außer Parameternamen verwendet wird, aktiviert das erste Zeichen jedes Wortes (einschließlich Akronyme mit einer Länge von mehr als zwei Buchstaben), wie in den folgenden Beispielen gezeigt:

• PropertyDescriptor
• HtmlTag

Ein Sonderfall wird für aus zwei Buchstaben bestehende Akronyme gemacht, bei denen beide Buchstaben groß geschrieben werden, wie in der folgenden Kennung gezeigt:

• IOStream

Die camelCasing- Konvention, die nur für Parameternamen verwendet wird, aktiviert das erste Zeichen jedes Wortes mit Ausnahme des ersten Wortes, wie in den folgenden Beispielen gezeigt. Wie das Beispiel auch zeigt, sind Akronyme aus zwei Buchstaben, die mit einer Kennung in Kamelhülle beginnen, beide Kleinbuchstaben.

• propertyDescriptor
• ioStream
• htmlTag

✓ Verwenden Sie PascalCasing für alle öffentlichen Mitglieder-, Typ- und Namespace-Namen, die aus mehreren Wörtern bestehen.

✓ Verwenden Sie camelCasing für Parameternamen.

Alte Frage, neue Antwort.

Gemäß .NET 4 Großschreibungsregeln für Akronyme :

Großschreiben Sie beide Zeichen von Akronymen mit zwei Zeichen, mit Ausnahme des ersten Wortes einer Kennung in Kamelhülle.

Eine benannte Eigenschaft DBRateist ein Beispiel für ein kurzes Akronym ( DB), das als erstes Wort eines Bezeichners mit Pascal-Gehäuse verwendet wird. Ein benannter Parameter ioChannelist ein Beispiel für ein kurzes Akronym ( IO), das als erstes Wort einer Kennung in Kamelhülle verwendet wird.

Schreiben Sie nur das erste Zeichen von Akronymen mit drei oder mehr Zeichen in Großbuchstaben, mit Ausnahme des ersten Wortes einer Kennung in Kamelhülle.

Eine benannte Klasse XmlWriterist ein Beispiel für ein langes Akronym, das als erstes Wort eines Bezeichners mit Pascal-Hülle verwendet wird. Ein benannter Parameter htmlReader ist ein Beispiel für ein langes Akronym, das als erstes Wort eines Kamelkennzeichens verwendet wird.

Großschreiben Sie keine der Zeichen von Akronymen, unabhängig von ihrer Länge, am Anfang einer Kennung in Kamelhülle.

Ein benannter Parameter xmlStreamist ein Beispiel für ein langes Akronym ( xml), das als erstes Wort eines Kamelkennzeichens verwendet wird. Ein benannter Parameter dbServerNameist ein Beispiel für ein kurzes Akronym ( db), das als erstes Wort einer Kennung in Kamelhülle verwendet wird.

Ich habe gehört, dass Sie Abkürzungen vermeiden sollten, damit es WindowsApplicationProgrammingInterfacedann wird.

Ernsthafter (Leute scheinen das Obige trotz des Zitats unten falsch zu lesen), diese Seite sagt:

Alle Akronyme mit drei oder mehr Buchstaben sollten Pascal-Groß- und Kleinschreibung sein, nicht alle Großbuchstaben.

Da API als bekanntes Akronym angesehen wird, müssen Sie den Namen WindowsApiauswählen, wenn Sie den Richtlinien folgen möchten.

Es ist alles nur eine persönliche (oder organisatorische) Präferenz. Solange Sie konsequent sind, werden Sie in Ordnung sein.

Das .NET Framework selbst würde WindowsApi verwenden.

Seine persönliche Präferenz. Aber .NET würde verwenden WindowsApi. Es ist vergleichbar mit der Benennung von TcpClient.

Schauen Sie sich auch FxCop an. Es ist ein nettes Dienstprogramm, das bei solchen Problemen hilft.