Les Commentaires Java, Comment bien Commenter son code?

Les commentaires permettent d’insérer du texte qui ne sera pas compilé ni interprété avec le reste du code. Il sert à ajouter du texte au code source. Il est utile pour expliquer ce que fait le code sourcepas plus.

Séparons une fois pour toute l’expression documenter de commenter.
Documenter, c’est fournir la description de son application, de tous ses points d’accès publics et de ses dépendances. La documentation s’occupe de décrire l’objet tel qu’il est utilisable par l’utilisateur.

Commenter, c’est décrire l’implémentation d’un objet, d’une méthode, d’une propriété, ou de toute variable spéciale d’une classe et de ses membres, quand la nécessité ou le besoin de confort l’exigent.
Les Commentaires ne sont pas pris en compte par le compilateur donc ils ne sont pas inclus dans le pseudo code. Ils ne se terminent pas
par un ;.
Il existe trois type de commentaire en Java :

Type de commentaires Exemple
commentaire abrégé // commentaire sur une seule ligne
int N=1; // déclaration du compteur
commentaire multiligne /* commentaires ligne 1
commentaires ligne 2 */
commentaire de documentation automatique /** commentaire */

 

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *