Programmation Java/Commentaires
Principe
modifierUn commentaire permet d'insérer du texte qui ne sera pas 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 chose à 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.
Par ailleurs, il existe aussi deux types de commentaires interprétables qui seront détaillées dans deux chapitres ultérieurs :
- les tags Javadoc, utilisés pour la documentation des classes.
- les annotations, pour donner des instructions relatives au programme.
Syntaxe
modifierLes commentaires en Java utilisent la même syntaxe qu'en C++ :
- 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 la fin du commentaire. En d'autres termes, tout ce qui est situé entre/*et*/est considéré comme faisant partie du commentaire.
Exemples
modifier// Un commentaire pour donner l'exemple
int n = 10; // 10 articles
/*
Ceci est un commentaire
sur plusieurs lignes.
*/
/*
Code de débogage désactivé :
int a=10;
while (a-->0) System.out.println("DEBUG: tab["+a+"]="+tab[a]);
*/