Convention de nommage Java avec acronymes

Question

Quel est le nom correct de la classe Java suivante : DVDPlayer o DvdPlayer ?

Answer 1

Puisqu'il semble que la réponse soit qu'il n'y a pas de norme unique pour cela en Java, j'aimerais noter que les directives de conception de .NET Framework le spécifient.

Avant de me reprocher d'être hors sujet, n'oubliez pas que les directives de dénomination des classes de Java et de .NET Framework sont assez similaires, ce qui rend les directives de .NET utiles comme référence convaincante.

Règles générales

Les deux directives recommandent de n'utiliser les acronymes que lorsque ceux-ci sont largement connus et bien compris. DVD ou XML en sont d'excellents exemples, car si vous les reconnaîtrez immédiatement, il vous faudra un peu plus de temps pour reconnaître la version étendue.

Abréviations

Les lignes directrices du cadre .NET recommandent de ne pas utiliser d'abréviations (par opposition aux acronymes), sauf que deux abréviations courantes ID y OK peuvent être utilisés dans les identificateurs. Lors de l'utilisation d'une abréviation, la casse mixte Id est toujours utilisé, sauf pour le premier mot d'un identifiant en camelCase (par opposition à un identifiant en PascalCase).

En Java, cette convention n'est respectée qu'une partie du temps. Jetez un coup d'œil à quel point les orthographes sont mélangées getID y getId sont dans le JCL. (Faites défiler cette page jusqu'en bas). Dans le Version de Java 8 cependant, getId est de plus en plus utilisée, ce qui indique que la convention PascalCase est aujourd'hui préférée. Il est préférable d'éviter complètement les abréviations lorsque cela est possible.

Acronymes courts

Les lignes directrices de .NET Framework stipulent que les acronymes à deux lettres comme IO doit avoir la même casse pour les deux lettres. Ainsi, pour les identifiants en PascalCase (comme un nom de classe), vous obtiendrez DBRate alors que pour un identificateur en camelCase (comme une variable locale), on peut avoir ioChannel .

Cela semble être la convention dominante en Java également.

Acronymes longs

Les directives du .NET Framework recommandent que les acronymes de trois lettres ou plus utilisent une casse mixte pour les identificateurs PascalCase et camelCase, sauf pour le premier mot d'un identificateur camelCase. Ainsi, pour un nom de classe, vous pourriez avoir XmlDocument alors qu'une variable locale peut être nommée httpRequest .

Cette convention n'est pas toujours respectée en Java. Les acronymes à quatre caractères semblent généralement utiliser la casse mixte, mais même le JCL n'est pas cohérent en ce qui concerne les acronymes à trois lettres. La plupart d'entre eux semblent être tout en majuscules, comme par exemple URL , XML , SQL et DOM mais il y a quelques exceptions comme Jar .

Conclusion

Pour Java :

Pour les acronymes de plus de 4 lettres, utilisez une casse mixte. La bibliothèque standard le fait, et c'est tout simplement logique.

Pour les acronymes de trois lettres, vous pouvez utiliser des majuscules comme pour le JCL, ou des minuscules et des minuscules comme pour le .NET Framework. Dans tous les cas, soyez cohérent.

Pour les acronymes de 2 lettres, utilisez les majuscules.

Pour les abréviations de deux lettres, Java n'a pas vraiment de norme, mais je suggère d'utiliser des majuscules et des minuscules, à moins que la cohérence avec d'autres noms ne rende les majuscules plus attrayantes.

Answer 2

Il n'y a pas de réponse "correcte". Il s'agit simplement d'un ensemble de pratiques et de conventions qui se marient mieux avec vos autres outils.

Je préfère donc DvdPlayer . C'est plus utile car dans Eclipse vous pouvez faire Ctrl + Shift + T et choisir les classes en fonction de la première lettre de chaque mot.

Answer 3

J'ai vu les deux utilisés dans la nature, et Sun semble opter pour le DVDPlayer le style. Je préfère DvdPlayer car de cette façon, les limites des mots sont claires, même s'il y a plusieurs acronymes consécutifs, comme dans l'exemple suivant HTTPURLConnection .

Answer 4

J'aime définir les instances individuelles des classes de la manière suivante :

Catalogue catalogue;
Person person;

Par conséquent, si j'ai utilisé DVDPlayer comment j'appellerais une instance de ça ? dVDPlayer ? Je choisirais donc le DvdPlayer Vous pouvez donc nommer les instances comme suit dvdPlayer .

Answer 5

Java efficace semble préférer DvdPlayer.