« Programmation Java/Commentaires » : différence entre les versions
Contenu supprimé Contenu ajouté
Aucun résumé des modifications |
|||
Ligne 6 :
Il est utile pour expliquer ce que fait le code source :
* 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.
Ligne 12 :
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
* [[../Tags Javadoc|les ''tags'' Javadoc]], utilisés pour la documentation des classes.
* [[../Annotations|les ''annotations'']], pour donner des instructions relatives au programme.
| |||