Java Language Conventions de nommage


Exemple

Noms de paquets

  • Les noms de paquets doivent être en minuscules, sans caractères de soulignement ou autres caractères spéciaux.
  • Les noms de package commencent par la partie d'autorité inversée de l'adresse Web de la société du développeur. Cette partie peut être suivie d'une sous-structure de package dépendant de la structure de projet / programme.
  • N'utilisez pas le pluriel. Suivez la convention de l'API standard qui utilise par exemple java.lang.annotation et non java.lang.annotations .
  • Exemples: com.yourcompany.widget.button , com.yourcompany.core.api

Noms de classe, d'interface et d'énumération

  • Les noms de classe et d'énumération doivent généralement être des noms.
  • Les noms d'interface doivent généralement être des noms ou des adjectifs se terminant par… able.
  • Utilisez la casse mixte avec la première lettre de chaque mot en majuscule (c.-à- d . CamelCase ).
  • Correspond à l'expression régulière ^[AZ][a-zA-Z0-9]*$ .
  • Utilisez des mots entiers et évitez d'utiliser des abréviations à moins que l'abréviation ne soit plus utilisée que la forme longue.
  • Formatez une abréviation en tant que mot si elle fait partie d’un nom de classe plus long.
  • Exemples: ArrayList , BigInteger , ArrayIndexOutOfBoundsException , Iterable .

Noms de méthode

Les noms de méthode doivent généralement être des verbes ou d'autres descriptions d'actions

  • Ils doivent correspondre à l'expression régulière ^[az][a-zA-Z0-9]*$ .
  • Utilisez la casse mixte avec la première lettre en minuscule.
  • Exemples: toString , hashCode

Les variables

Les noms de variables doivent être en casse mixte avec la première lettre en minuscule

  • Correspond à l'expression régulière ^[az][a-zA-Z0-9]*$
  • Recommandation supplémentaire: Variables
  • Exemples: elements , currentIndex

Variables de type

Pour les cas simples où peu de variables de type impliquent, utilisez une seule lettre majuscule.

  • Correspond à l'expression régulière ^[AZ][0-9]?$
  • Si une lettre est plus descriptive qu'une autre (comme K et V pour les clés et les valeurs dans les cartes ou R pour un type de retour de fonction), utilisez-la, sinon utilisez T
  • Pour les cas complexes où les variables de type lettre unique deviennent confuses, utilisez des noms plus longs écrits dans toutes les majuscules et utilisez le trait de soulignement ( _ ) pour séparer les mots.
  • Exemples: T , V , SRC_VERTEX

Les constantes

Les constantes (champs static final dont le contenu est immuable, par règles de langage ou par convention) doivent être nommées avec toutes les majuscules et le trait de soulignement ( _ ) pour séparer les mots.

  • Correspond à l'expression régulière ^[AZ][A-Z0-9]*(_[A-Z0-9]+)*$
  • Exemples: BUFFER_SIZE , MAX_LEVEL

Autres directives sur le nommage

  • Évitez de masquer / masquer les méthodes, les variables et les variables de type dans les étendues externes.
  • Laisser la verbosité du nom correspondre à la taille de la portée. (Par exemple, utilisez des noms descriptifs pour les champs des grandes classes et des noms abrégés pour les variables locales à courte durée de vie.)
  • Lorsque vous nommez des membres statiques publics, laissez l'identificateur être auto-descriptif si vous pensez qu'ils seront importés de manière statique.
  • Lectures complémentaires: Section de nommage (dans le Guide de style Java officiel)

Source: Directives de style Java d'Oracle