Les bonnes pratiques en java
Les bonnes pratiques en java
-
Objectifs
-
Les indentations
- En informatique, l’indentation désigne le fait d’ajouter des tabulations ou des espaces à un fichier texte.
- L’indentation décrit les différents moyens utilisés par les programmeurs pour faire ressortir un morceau de code. L’indentation n’est pas seulement une question d’esthétique. En fait, pour quelques langages, elle est nécessaire afin de former des blocs ou des lignes efficaces. (Par exemple Occam, Fortran ou Python).
- Il existe plusieurs styles d’indentation tels que : Style Allman, Style K&R ou Style Whitesmiths, etc.
- En programmation, l’indentation est tout comme le formatage. Elle est utilisée pour rendre le code lisible aux autres utilisateurs, car elle rend le code plus facile à modifier, montre comment les accolades s’emboîtent et illustre la logique du programme de manière bien organisée. Elle signale au lecteur qu’il est sur le point de se plonger dans une nouvelle section du programme.
- Le but de l’indentation est de montrer la logique du programme. Nous devons conserver l’indentation tout au long du programme, car c’est un élément essentiel de la mise en forme.
- Les accolades utilisées en Java suivent le style Kernighan et Ritchie (style K & R) pour indenter les différents blocs.
- Pas de retour à la ligne avant l’accolade d’ouverture.
- Saut de ligne après l’accolade d’ouverture.
- Saut de ligne avant l’accolade fermante.
- Saut de ligne après l’accolade fermante, uniquement si cette accolade termine une déclaration ou le corps d’une méthode, d’un constructeur ou d’une classe nommée. Par exemple, il n’y a pas de saut de ligne après l’accolade si elle est suivie de else ou d’une virgule.
-
Les conventions de nommage
- La convention de nommage est un ensemble de normes à suivre qui vous permet de décider comment nommer des identifiants tels que classe, paquetage, variable, constante, méthode, etc. Mais il n’est pas nécessaire de la suivre. C’est pourquoi elle est connue comme une convention.
- Ces conventions sont suggérées par plusieurs communautés Java telles que Sun Microsystems et Netscape. Toutes les classes, interfaces, paquets, méthodes et champs du langage de programmation Java sont donnés selon la convention de dénomination Java.
- Si vous ne suivez pas ces conventions, cela peut entraîner une confusion ou un code erroné.
- Remarque
- En utilisant les conventions de nommage Java, la lecture du code devient plus facile par les autres programmeurs. La lisibilité du programme Java est très importante. Il indique que moins de temps est consacré à comprendre ce que le code fait.
- Exemple
- Le nom ne doit pas contenir d’espaces blancs,
- Le nom ne doit pas commencer avec des personnages spéciaux comme & (ampersand), $ (dollar), _ (soulignement),
- Les noms de classes doivent commencer par une lettre majuscule,
- Les variables et les méthodes doivent commencer par une lettre minuscule,
- Si le nom d’une méthode contient plusieurs mots, il faut commencer par une lettre,
- Minuscule suivie d’une lettre majuscule telle que actionPerformed(),
- Éviter d’utiliser des variables à caractère unique telles que x, y, z.
-
Les commentaires
- Un commentaire permet d’insérer du texte qui ne sera ni compilé ni interprété. Il sert à ajouter du texte au code source. Il est utile pour expliquer ce que fait le code source :
- Expliquer comment utiliser la classe / la méthode correctement, à quel moment, avec quels types de paramètres, etc.
- Expliquer le choix technique effectué : pourquoi tel algorithme et pas un autre, pourquoi appeler telle méthode, pourquoi telle valeur pour la constante, etc.
- Expliquer ce qui devra être fait par la suite (liste de choses à faire) : amélioration, problème à corriger, etc.
- Donner les explications nécessaires à la compréhension du code pour le reprendre soi-même plus tard, ou pour d’autres développeurs.
- Il peut aussi être utilisé pour que le compilateur ignore une partie du code : code temporaire de débogage, code en cours de développement, etc.
- Il existe aussi deux syntaxes de commentaire :
- La séquence // permet d’insérer un commentaire sur une seule ligne, qui se termine donc à la fin de la ligne.
- La séquence /* …*/ permet d’insérer un commentaire sur plusieurs lignes :
- La séquence /* marque le début du commentaire.
- La séquence */ marque la fin du commentaire.
- En d’autres termes, tout ce qui est situé entre /* et */ est considéré comme faisant partie du commentaire.
-
Les recommandations sur la déclaration des variables
- Une variable est une donnée (un objet ou un type primitif) repérée par son nom, et qui pourra être lue, ou modifiée lors de l’exécution du programme. Les variables en langage Java sont typées, c’est-à-dire que les données contenues dans celles-ci possèdent un type. Ainsi, elles sont donc stockées à une adresse mémoire et occupent un nombre d’octets dépendant du type de donnée conservée.
- En Java, les noms de variables peuvent être aussi longs que l’on désire. Toutefois le compilateur ne tiendra compte « que » des 247 premiers caractères.
- De plus, elles doivent répondre à certains critères :
- Un nom de variable ne peut comporter que des lettres, des chiffres (les caractères ‘_ ‘ et $ peuvent être utilisés, mais ne devraient pas l’être pour des variables),
- Un nom de variable ne peut pas commencer par un chiffre et ne doit pas comporter d’espace,
- Les noms de variables ne peuvent pas être les noms réservés du langage. Exemple :
- Abstract, assert,
- Boolean, break, byte,
- Case, catch, char, class, const, continue.
- De plus, les noms de variables sont sensibles à la casse (Java fait la différence entre les lettres minuscules et majuscules, avec ou sans accent). Il faut donc veiller à respecter impérativement la casse des noms !
- Par convention, un nom de variable est écrit en minuscules, sans accent, ni _ ou $. En revanche, lorsqu’il est composé de plusieurs mots, on peut utiliser une majuscule pour l’initiale de chaque nouveau mot.
