Utilisation des conventions de dénomination Java

Une convention de dénomination est une règle à suivre lorsque vous décidez comment nommer vos identifiants (par exemple classe, package, variable, méthode, etc.).

Pourquoi utiliser les conventions de dénomination?

Différents programmeurs Java peuvent avoir différents styles et différentes approches de programmation. En utilisant les conventions de dénomination Java standard, ils facilitent la lecture de leur code pour eux-mêmes et pour les autres programmeurs. La lisibilité du code Java est importante car elle signifie moins de temps à essayer de comprendre ce que fait le code, ce qui laisse plus de temps pour le corriger ou le modifier.

Pour illustrer ce point, il convient de mentionner que la plupart des éditeurs de logiciels disposeront d'un document décrivant les conventions de dénomination qu'ils souhaitent que leurs programmeurs respectent. Un nouveau programmeur qui se familiarisera avec ces règles pourra comprendre le code écrit par un programmeur qui aurait pu quitter l'entreprise plusieurs années auparavant.

Choisir un nom pour votre identifiant

Lorsque vous choisissez un nom pour un identifiant, assurez-vous qu'il est significatif. Par exemple, si votre programme traite des comptes clients, choisissez des noms qui ont du sens pour traiter avec les clients et leurs comptes (par exemple, customerName, accountDetails). Ne vous inquiétez pas de la longueur du nom. Un nom plus long qui résume parfaitement l'identifiant est préférable à un nom plus court qui peut être rapide à taper mais ambigu.

Quelques mots sur les cas

L'utilisation de la bonne casse est la clé pour suivre une convention de dénomination:

• Minuscule est l'endroit où toutes les lettres d'un mot sont écrites sans aucune majuscule (par exemple, tandis que, si, mypackage).
• Majuscule est l'endroit où toutes les lettres d'un mot sont écrites en majuscules. Lorsqu'il y a plus de deux mots dans le nom, utilisez des traits de soulignement pour les séparer (par exemple, MAX_HOURS, FIRST_DAY_OF_WEEK).
• Affaire de chameau (également appelé Upper CamelCase) est l'endroit où chaque nouveau mot commence par une majuscule (par exemple, CamelCase, CustomerAccount, PlayingCard).
• Boîtier mixte (également appelé Lower CamelCase) est identique à CamelCase, sauf que la première lettre du nom est en minuscules (par exemple, hasChildren, customerFirstName, customerLastName).

Conventions de nommage Java standard

La liste ci-dessous décrit les conventions de dénomination Java standard pour chaque type d'identifiant:

• Paquets: Les noms doivent être en minuscules. Avec les petits projets qui n'ont que quelques packages, il est normal de leur donner des noms simples (mais significatifs!):

   package pokeranalyzer package mycalculator 

  Dans les éditeurs de logiciels et les grands projets où les packages peuvent être importés dans d'autres classes, les noms seront normalement subdivisés. En règle générale, cela commencera par le domaine de l'entreprise avant d'être divisé en couches ou fonctionnalités:

   package com.mycompany.utilities package org.bobscompany.application.userinterface 

• Des classes: Les noms doivent être dans CamelCase. Essayez d'utiliser des noms car une classe représente normalement quelque chose dans le monde réel:

   classe Client classe Compte 

• Interfaces: Les noms doivent être dans CamelCase. Ils ont tendance à avoir un nom qui décrit une opération qu'une classe peut effectuer:

   interface Interface comparable Enumerable 

  Notez que certains programmeurs aiment distinguer les interfaces en commençant le nom par un "I":

   interface IComparable interface IEnumerable 

• Méthodes: Les noms doivent être en casse mixte. Utilisez des verbes pour décrire ce que fait la méthode:

   void CalculateTax () string getSurname () 

• Variables: Les noms doivent être en casse mixte. Les noms doivent représenter ce que représente la valeur de la variable:

   chaîne firstName int orderNumber 

  N'utilisez des noms très courts que lorsque les variables sont de courte durée, comme dans les boucles for:

   pour (int i = 0; i<20;i++)    //i only lives in here  

• Constantes: Les noms doivent être en majuscules.

   statique final int DEFAULT_WIDTH statique final int MAX_HEIGHT