Convenzione di denominazione Java con acronimi [chiuso]

Qual è il nome corretto per la seguente classe Java: DVDPlayero DvdPlayer?

Poiché sembra che la risposta sia che non esiste un unico standard per questo in Java, vorrei notare che le Linee guida per la progettazione di .NET Framework lo specificano.

Ora, prima di sbattermi per essere fuori tema, ricorda che le linee guida per la denominazione delle classi per Java e .NET Framework sono abbastanza simili, il che rende le linee guida .NET utili come riferimento persuasivo.

Regole generali

Entrambe le linee guida raccomandano di usare gli acronimi solo quando l'acronimo è ampiamente conosciuto e ben compreso. DVD o XML ne sono un eccellente esempio, poiché mentre li riconoscerai immediatamente, ci vorrebbe un po 'più tempo per riconoscere la versione espansa.

Abbreviazioni

Le Linee guida di .NET Framework raccomandano di non utilizzare abbreviazioni (in contrapposizione agli acronimi), tranne per il fatto che negli identificatori possono essere usate due abbreviazioni comuni "ID" e "OK". Quando si utilizza un'abbreviazione, Idviene sempre utilizzato il caso misto, ad eccezione della prima parola di un identificatore camelCase (al contrario di un identificatore PascalCase).

In Java questa convenzione è seguita solo un po 'di tempo. Dai un'occhiata a quanto sono mescolati gli incantesimi getIDe getIdquelli nel JCL. (Scorri parzialmente verso il basso quella pagina). Nella versione Java 8, tuttavia, getIdviene utilizzato sempre di più, il che suggerisce che la convenzione PascalCase è preferita al giorno d'oggi. È meglio evitare solo abbreviazioni quando possibile.

Acronimi brevi

Le Linee guida di .NET Framework affermano che gli acronimi di due lettere come "IO" dovrebbero avere lo stesso caso per entrambe le lettere. Quindi per gli identificatori PascalCase (come un nome di classe) potresti ottenere DBRate, mentre per un identificatore camelCase (come una variabile locale) potresti avere ioChannel.

Questa sembra sicuramente essere la convenzione prevalente anche in Java.

Acronimi lunghi

Le linee guida di .NET Framework raccomandano che gli acronimi di tre lettere o più utilizzino maiuscole e minuscole per gli identificatori PascalCase e camelCase, ad eccezione della prima parola di un identificatore camelCase. Quindi per un nome di classe potresti avere XmlDocument, mentre una variabile locale potrebbe essere nominata httpRequest.

Questa convenzione non è sempre seguita in Java. Di solito, gli acronimi a quattro caratteri usano un caso misto, ma anche il JCL non è coerente con gli acronimi a tre lettere. La maggior parte di essi sembra essere maiuscola, come "URL", "XML", "SQL" e "DOM", ma ci sono alcune eccezioni come "Jar".

Conclusione

Per Java:

Per acronimi di 4+ lettere, usare maiuscole e minuscole. La libreria standard fa questo, e ha solo un buon senso.

Per gli acronimi a 3 lettere, puoi usare tutte le maiuscole come JCL, oppure puoi usare maiuscole e minuscole come fa .NET Framework. Ad ogni modo, sii coerente.

Per gli acronimi di 2 lettere, utilizzare tutte le lettere maiuscole.

Per le abbreviazioni di 2 lettere, Java non ha davvero uno standard, ma suggerisco di usare maiuscole e minuscole, a meno che la coerenza con altri nomi non apporterebbe un aspetto migliore alle maiuscole.

Non esiste una risposta "corretta". Solo una serie di pratiche e convenzioni che giocano meglio con gli altri tuoi strumenti.

Quindi preferisco DvdPlayer. È più utile come in Eclipse puoi fare Ctrl+ Shift+ Te scegliere le classi dalla prima lettera di ogni parola.

Ho visto entrambi usati allo stato brado e Sun sembra optare per lo DVDPlayerstile. Preferisco DvdPlayer, però, perché in questo modo è chiaro dove si trovano i confini della parola anche se ci sono più acronimi consecutivi, come in HTTPURLConnection.

Mi piace definire le singole istanze delle classi nel modo seguente:

Catalogue catalogue;
Person person;

Pertanto, se usassi DVDPlayer, come definirei un'istanza di quello? dVDPlayer? Quindi sceglierei il DvdPlayernome della classe, in modo da poter denominare le istanze come dvdPlayer.

Alcuni esempi delle classi JavaSE, dei comuni di Apache e di Spring:

• HttpURLConnection
• HTTPAddress
• UrlPathHelper
• AopProxy
• ISBNValidator

Quindi - non importa davvero.

L'efficace Java sembra preferire DvdPlayer.

Come altri hanno indicato, è una cosa di stile che differisce tra i progetti. I progetti Google come Guava e GWT preferiscono lo DvdPlayerstile.

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

Dai documenti di Sun Java :

I nomi delle classi dovrebbero essere nomi, in caso misto con la prima lettera di ogni parola interna in maiuscolo. Cerca di mantenere i nomi delle tue classi semplici e descrittivi. Usa parole intere per evitare acronimi e abbreviazioni (a meno che l'abbreviazione non sia molto più ampiamente utilizzata rispetto alla forma lunga, come URL o HTML).

DVDPlayerè lo standard, ma DvdPlayernon è raro.

Più spesso che non vedi getId. Ciò è probabilmente dovuto al fatto che l'ID è un accorciamento di "identità". In realtà sono le iniziali del documento di identità.

HttpURLConnectionviene spesso fornito come esempio di convenzione mista. Tuttavia, "http" utilizzato come nome del protocollo in un URL deve essere in minuscolo (sebbene il maiuscolo sia spesso accettato).

Non c'è "corretto", solo preferenze qui.

Sun è coerente nel modo in cui chiamano le classi contenenti "URL" e "HTML", ma vedo HTTP che usa sia maiuscole che minuscole nei javadocs.

Personalmente, preferirei DvdPlayer.