Algorithmique et langage Java

Commenter son code

On peut inclure des commentaires dans le fichier code de deux façons :
• Un double slash // signale le début d'un commentaire qui se termine à la fin de la ligne (retour chariot). Ce type de commentaire peut occuper une ligne entière ou bien se placer à la suite d'une ligne de code, après le point-virgule.
• Les codes /* et */ signalent, respectivement, le début et la fin d'un commentaire. Ces codes sont typiquement utilisés pour encadrer un commentaire de plusieurs lignes.

Dans un éditeur de texte utilisant la coloration syntaxique les commentaires apparaissent d'une couleur spécifique (en général, par convention, le vert).

L'utilité première des commentaires est d'expliquer le code, mais ce n'est pas la seule :
Transformer du code en commentaire est aussi un moyen rapide de le neutraliser sans l'effacer : c'est très utile lorsqu'on débogue un programme.
Sous Eclipse et d'autres environnements de programmation, un commentaire contenant l'indication "TODO" est signalé par un petit marqueur dans la marge. Cela permet d'indiquer les endroits où il reste des choses à faire... bien utile dès que le programme est un peu long!