Convention de dénomination Java avec acronymes [fermé]

Quel est le nom correct pour la classe Java suivante: DVDPlayerou DvdPlayer?

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

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

Règles générales

Les deux lignes directrices recommandent d'utiliser uniquement des acronymes lorsque l'acronyme est largement connu et bien compris. Les DVD ou XML en sont d'excellents exemples, car même si vous les reconnaîtrez immédiatement, il faudrait un peu plus de temps pour reconnaître la version étendue.

Abréviations

Les directives du .NET Framework recommandent de ne pas utiliser d'abréviations (par opposition aux acronymes), sauf que deux abréviations courantes «ID» et «OK» peuvent être utilisées dans les identificateurs. Lors de l'utilisation d'une abréviation, la casse mixte Idest toujours utilisée sauf pour le premier mot d'un identifiant camelCase (par opposition à un identifiant PascalCase).

En Java, cette convention n'est suivie que de temps en temps. Jetez un œil à la façon dont les orthographes sont mélangées getIDet getIddans le JCL. (Faites défiler à mi-chemin sur cette page). Dans la version Java 8, cependant, getIdest de plus en plus utilisé, ce qui laisse entendre que la convention PascalCase est préférée de nos jours. Il est préférable d'éviter simplement les abréviations lorsque cela est possible.

Acronymes courts

Les directives du .NET Framework indiquent que les acronymes à deux lettres comme «IO» devraient avoir le même cas pour les deux lettres. Donc, pour les identifiants PascalCase (comme un nom de classe), vous obtiendriez DBRate, tandis que pour un identifiant camelCase (comme une variable locale), vous pourriez en avoir ioChannel.

Cela semble certainement être la convention dominante à Java également.

Acronymes longs

Les directives .NET Framework recommandent que les acronymes de trois lettres ou plus utilisent une casse mixte pour les identifiants PascalCase et camelCase, à l'exception du premier mot d'un identifiant camelCase. Ainsi, pour un nom de classe, vous pourriez avoirXmlDocument , alors qu'une variable locale pourrait être nommée httpRequest.

Cette convention n'est pas toujours suivie en Java. Les acronymes à quatre caractères semblent généralement utiliser des majuscules, mais même le JCL n'est pas cohérent avec les acronymes à trois lettres. La plupart d'entre eux semblent tout en majuscules, comme «URL», «XML», «SQL» et «DOM», mais il existe quelques exceptions comme «Jar».

Conclusion

Pour Java:

Pour les acronymes de 4 lettres ou plus, utilisez la casse mixte. La bibliothèque standard fait cela, et c'est tout à fait logique.

Pour les acronymes de 3 lettres, vous pouvez utiliser tous les majuscules comme le JCL, ou vous pouvez utiliser des majuscules comme le .NET Framework. Quoi qu'il en soit, soyez cohérent.

Pour les acronymes de 2 lettres, utilisez tout en majuscules.

Pour les abréviations à 2 lettres, Java n'a pas vraiment de standard, mais je suggère d'utiliser une casse mixte, sauf si la cohérence avec d'autres noms rendrait tous les majuscules plus beaux.

Il n'y a pas de réponse "correcte". Juste un ensemble de pratiques et de conventions qui jouent mieux avec vos autres outils.

Je préfère donc DvdPlayer. C'est plus utile car dans Eclipse vous pouvez faire Ctrl+ Shift+ Tet choisir des classes par la première lettre de chaque mot.

Je les ai vus tous les deux utilisés à l'état sauvage, et Sun semble aller pour le DVDPlayerstyle. Je préfère DvdPlayer, cependant, car de cette façon, il est clair où se trouvent les limites des mots même s'il existe plusieurs acronymes consécutifs, comme dans HTTPURLConnection.

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

Catalogue catalogue;
Person person;

Par conséquent, si j'utilisais DVDPlayer, comment pourrais-je appeler une instance de cela? dVDPlayer? Par conséquent, je choisirais le DvdPlayernom de la classe, afin que vous puissiez nommer les instances comme dvdPlayer.

Quelques exemples des classes JavaSE, apache commons et spring:

• HttpURLConnection
• HTTPAddress
• UrlPathHelper
• AopProxy
• ISBNValidator

Donc - ça n'a pas vraiment d'importance.

Java efficace semble préférer DvdPlayer.

Comme d'autres l'ont indiqué, c'est une chose de style qui diffère selon les projets. Les projets Google tels que Guava et GWT préfèrent le DvdPlayerstyle.

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

De la documentation de Sun Java :

Les noms de classe doivent être des noms, en casse mixte avec la première lettre de chaque mot interne en majuscule. Essayez de garder vos noms de classe simples et descriptifs. Utilisez des mots entiers - évitez les acronymes et les abréviations (sauf si l'abréviation est beaucoup plus largement utilisée que la forme longue, comme URL ou HTML).

DVDPlayer est la norme, mais DvdPlayer n'est pas rare.

Vous voyez le plus souvent getId. Cela est probablement dû au fait que l'identification est un raccourcissement de «l'identité». Il s'agit en fait des initiales du document d'identité.

HttpURLConnectionest souvent donné comme exemple de convention mixte. Cependant, "http" utilisé comme nom de protocole dans une URL doit être en minuscules (bien que les majuscules soient souvent acceptées).

Il n'y a pas de "correct", seulement des préférences ici.

Sun est cohérent dans la façon dont ils nomment les classes contenant "URL" et "HTML", mais je vois HTTP utilisant à la fois toutes les majuscules et le cas de chameau dans les javadocs.

Personnellement, je préfère DvdPlayer.