Java-Namenskonvention mit Akronymen [geschlossen]

Wie lautet der korrekte Name für die folgende Java-Klasse: DVDPlayeroder DvdPlayer?

Da es so aussieht, als gäbe es in Java keinen einzigen Standard dafür, möchte ich darauf hinweisen, dass die .NET Framework-Entwurfsrichtlinien dies spezifizieren.

Bevor Sie mich dafür kritisieren, dass ich nicht zum Thema gehöre, denken Sie bitte daran, dass die Richtlinien für die Benennung von Klassen für Java und .NET Framework ziemlich ähnlich sind, was die .NET-Richtlinien als überzeugende Referenz nützlich macht.

Allgemeine Regeln

In beiden Richtlinien wird empfohlen, Akronyme nur zu verwenden, wenn das Akronym allgemein bekannt und bekannt ist. DVD oder XML sind hervorragende Beispiele dafür, da Sie sie zwar sofort erkennen, das Erkennen der erweiterten Version jedoch etwas länger dauern würde.

Abkürzungen

In den .NET Framework-Richtlinien wird empfohlen, keine Abkürzungen (im Gegensatz zu Akronymen) zu verwenden, außer dass zwei häufig verwendete Abkürzungen "ID" und "OK" in Bezeichnern verwendet werden können. Bei Verwendung einer Abkürzung Idwird immer eine gemischte Groß- und Kleinschreibung verwendet, mit Ausnahme des ersten Wortes einer camelCase-Kennung (im Gegensatz zu einer PascalCase-Kennung).

In Java wird diese Konvention nur teilweise befolgt. Werfen Sie einen Blick darauf , wie die Schreibweisen gemischt getIDund getIdsind in der JCL. (Scrollen Sie teilweise auf dieser Seite nach unten). In der Version Java 8 allerdings getIdmehr und mehr verwendet, die Hinweise die Pascalkonvention heute bevorzugt. Es ist am besten, Abkürzungen möglichst vollständig zu vermeiden.

Kurze Akronyme

Die .NET Framework-Richtlinien besagen, dass zwei Buchstabenakronyme wie "IO" für beide Buchstaben den gleichen Fall haben sollten. Für PascalCase-Bezeichner (wie einen Klassennamen) würden Sie also erhalten DBRate, während Sie für einen camelCase-Bezeichner (wie eine lokale Variable) möglicherweise haben ioChannel.

Dies scheint definitiv auch in Java die vorherrschende Konvention zu sein.

Lange Akronyme

In den .NET Framework-Richtlinien wird empfohlen, dass Akronyme mit drei oder mehr Buchstaben für PascalCase- und camelCase-Bezeichner eine Groß- und Kleinschreibung verwenden, mit Ausnahme des ersten Wortes eines camelCase-Bezeichners. Für einen Klassennamen, den Sie möglicherweise haben XmlDocument, kann eine lokale Variable benannt werden httpRequest.

Diese Konvention wird in Java nicht immer befolgt. Akronyme mit vier Zeichen scheinen normalerweise gemischte Groß- und Kleinschreibung zu verwenden, aber selbst die JCL stimmt nicht mit Akronymen mit drei Buchstaben überein. Die meisten von ihnen scheinen Großbuchstaben zu sein, wie "URL", "XML", "SQL" und "DOM", aber es gibt einige Ausnahmen wie "Jar".

Fazit

Für Java:

Verwenden Sie für Akronyme mit mehr als 4 Buchstaben die Groß- und Kleinschreibung. Die Standardbibliothek macht das und es macht einfach Sinn.

Für 3-Buchstaben-Akronyme können Sie alle Großbuchstaben wie die JCL verwenden, oder Sie können gemischte Groß- und Kleinschreibung verwenden, wie dies bei .NET Framework der Fall ist. Sei auf jeden Fall konsequent.

Verwenden Sie für Akronyme mit 2 Buchstaben alle Großbuchstaben.

Für Abkürzungen mit 2 Buchstaben hat Java nicht wirklich einen Standard, aber ich schlage vor, gemischte Groß- und Kleinschreibung zu verwenden, es sei denn, die Konsistenz mit anderen Namen würde dazu führen, dass alle Großbuchstaben besser aussehen.

Es gibt keine "richtige" Antwort. Nur eine Reihe von Praktiken und Konventionen, die besser mit Ihren anderen Tools spielen.

Deshalb bevorzuge ich DvdPlayer. Es ist hilfreich , wie in Eclipse können Sie tun , Ctrl+ Shift+ Tund durch den ersten Buchstaben jedes Wortes Klassen wählen.

Ich habe gesehen, dass beide in freier Wildbahn verwendet wurden, und Sun scheint sich für den DVDPlayerStil zu entscheiden. Ich bevorzuge es DvdPlayerjedoch, weil auf diese Weise klar ist, wo die Wortgrenzen liegen, auch wenn es mehrere aufeinanderfolgende Akronyme gibt, wie in HTTPURLConnection.

Ich möchte einzelne Instanzen von Klassen folgendermaßen definieren:

Catalogue catalogue;
Person person;

DVDPlayerWie würde ich eine Instanz davon nennen , wenn ich sie verwenden würde? dVDPlayer? Daher würde ich den DvdPlayerKlassennamen wählen , damit Sie die Instanzen wie folgt benennen können dvdPlayer.

Einige Beispiele aus den JavaSE-Klassen, Apache Commons und Spring:

• HttpURLConnection
• HTTPAddress
• UrlPathHelper
• AopProxy
• ISBNValidator

Also - es ist nicht wirklich wichtig.

Effektives Java scheint DvdPlayer zu bevorzugen.

Wie andere bereits angedeutet haben, ist es ein Stil, der sich von Projekt zu Projekt unterscheidet. Google-Projekte wie Guava und GWT bevorzugen den DvdPlayerStil.

https://google.github.io/styleguide/javaguide.html#s5.3-camel-case

Von Sun Java Docs :

Klassennamen sollten Substantive sein, in gemischtem Fall, wobei der erste Buchstabe jedes internen Wortes groß geschrieben wird. Versuchen Sie, Ihre Klassennamen einfach und beschreibend zu halten. Verwenden Sie ganze Wörter, vermeiden Sie Akronyme und Abkürzungen (es sei denn, die Abkürzung wird viel häufiger verwendet als die Langform wie URL oder HTML).

DVDPlayerist der Standard, aber DvdPlayernicht ungewöhnlich.

Sie sehen meistens nicht getId. Das liegt wahrscheinlich daran, dass ID eine Abkürzung von "Identität" ist. Es sind eigentlich die Initialen des Ausweises.

HttpURLConnectionwird oft als Beispiel für eine gemischte Konvention angegeben. "Http", das als Protokollname in einer URL verwendet wird, sollte jedoch in Kleinbuchstaben geschrieben werden (obwohl Großbuchstaben häufig akzeptiert werden).

Es gibt hier keine "richtigen", nur Einstellungen.

Sun ist in der Art und Weise konsistent, wie sie Klassen benennen, die "URL" und "HTML" enthalten, aber ich sehe, dass HTTP in den Javadocs sowohl Großbuchstaben als auch Kamel-Groß- und Kleinschreibung verwendet.

Persönlich würde ich DvdPlayer bevorzugen.