Wie man Akronyme in Entitätsnamen groß schreibt?

7
Nehmen wir einmal an, dass Sie nach einer Konvention in einer Sprache programmieren, die Camelcase-Wörter als Bezeichner verwendet. Alle Ruby-Typen mit Ihren durch Unterstriche getrennten Methodennamen können diesen Fehler beheben.

Welchen Ansatz nimmst du, um die Buchstaben nach dem ersten zu kapitalisieren, wenn dein Name ein Akronym enthält? Würden Sie zum Beispiel eine Methode createSQLBuffer oder createSqlBuffer aufrufen? Haben Sie eine Richtlinie, die vorschreibt, was in dieser Situation zu tun ist? Kann mir darüber hinaus jemand Artikel zukommen lassen, die das eine oder andere speziell anpreisen, oder tatsächlich alles, was das überhaupt abdeckt?

Ich weiß, dass es nicht wirklich eine große Sache ist, aber aus irgendeinem Grund stoße ich manchmal auf eine Methode / Klasse / Variable, die in Großbuchstaben geschrieben ist und so, dass sie den anderen natürlicher aussehen würde. Das Seltsame ist, dass ich nicht einmal sicher bin, ob es konsistent ist; Es würde mich nicht überraschen, wenn ich feststelle, dass ich für bestimmte Namen Großbuchstaben und für andere Großbuchstaben mag.

Möchte jemand seine Meinung dazu mitteilen?

    
Andrzej Doyle 09.01.2009, 17:33
quelle

5 Antworten

11

Ich bin ein Fan davon, Akronyme als ein Wort zu behandeln, wenn ich kapitalisiere, also mag ich createSqlBuffer.

    
Brian Fisher 09.01.2009, 17:35
quelle
4

Die .NET-Benennungsrichtlinien (auch wenn sie pascal sind) schlagen vor, nur den ersten Buchstaben in einem Akronym groß zu schreiben, es sei denn, es handelt sich um ein aus zwei Buchstaben bestehendes Akronym (also createSqlBuffer , aber createIOBuffer ).

    
bdukes 09.01.2009 17:39
quelle
3

IMO, wenn nur der erste Buchstabe eines Akronyms großgeschrieben wird, macht Sinn, wenn Kamelgehäuse, nur weil die Kapitalisierung des gesamten Wortes das Kamelgehäuse-Verhalten bricht. Die Großbuchstaben in einem Kamel-Wort sollen den Beginn eines jeden Wortes anzeigen, und nicht den normalen englischen Casing-Regeln folgen. Wenn Sie ein ganzes Akronym groß schreiben, verlieren Sie die klare Trennung zwischen dem Ende des Akronyms und dem Anfang des nächsten Wortes.

Es ist auch einfacher, mit nur einem Großbuchstaben (und etwas schöner auf den Augen) zu tippen.

Ich stimme jedoch mit IO und den meisten anderen aus zwei Buchstaben bestehenden Abkürzungen überein. Normalerweise würde ich sie in Großbuchstaben schreiben lassen, auch wenn ich das oben erwähnte in Betracht ziehe. Am Ende geht es wirklich darum, was leichter zu lesen ist.

    
P Daddy 09.01.2009 18:21
quelle
1

Es mag etwas leichter für das Auge sein, fudgeSql () als fudgeSQL () zu haben, aber das letztere scheint manchmal in bestimmten Kontexten richtiger zu sein.

Es wird Zeiten geben, in denen Sie mit einem Akronym und einem anderen Akronym nebeneinander in einem Klassennamen oder Methodennamen enden, und das ist nicht so nett. Es ist auch ein bisschen einfacher, nur zu dem einzigen Kapital, wenn ich irgendwie tippe. Ich denke jedoch nicht, dass es in allen Fällen schön wäre, es zu haben. Sicher I / O - & gt; IO, ich würde es hassen, Io (ein Jupitermond) als Teil eines Klassen- oder Methodennamens zu sehen. Vielleicht ist es eines dieser Dinge, die subjektiv sind und vom Akronym selbst abhängen. Solange Sie konsistent sind ...

Eine Sache, in Java, mit Getter und Setter ist, dass mit dem oberen Gehäuse, Ihre Variablen am Ende sein müssen:

%Vor%

eher als die schönere

%Vor%

weil die generierten Getter und Setter (in Eclipse sowieso)

%Vor%

stimmen nicht mit der Namenskonvention überein.

%Vor%

Wenn Sie sehen, was ich meine.

    
JeeBee 09.01.2009 17:49
quelle
1

Ich habe die Erfahrung gemacht, dass die Usual Konvention Caps als Worttrennzeichen behandelt, also usesql und UseSQL. Die richtige Antwort ist die Verwendung der Konvention, die den Code am klarsten macht, und die konsistente Verwendung. Wie JeeBee hervorhebt, kann dies durch die Annahmen Ihrer Werkzeuge beeinflusst werden.

    
Charlie Martin 09.01.2009 18:04
quelle

Tags und Links

Django: Verwenden von Annotate, Count und Distinct in einem Queryset Wie kann ich ein abgebrochenes HttpWebRequest erneut anfordern?