Commentaire

Définition - Que signifie le commentaire?

Un commentaire est une construction spéciale dans un langage de programmation qui permet au développeur du programme de mentionner des informations supplémentaires associées au programme. La principale raison de l'inclusion de commentaires dans les langages de programmation est d'améliorer la portabilité et la maintenabilité d'un code.

Definir Tech explique comment

Souvent, les équipes de développement de logiciels travaillent ensemble sur différents modules logiciels, qui sont inspectés par des ingénieurs de test pendant le processus de test. Pendant le processus de test, les ingénieurs doivent être conscients du fonctionnement d'un module. Par conséquent, des commentaires sont inclus par le développeur pour expliquer le fonctionnement d'un module particulier en indiquant les types d'entrées valides, le nombre d'entrées, l'algorithme utilisé pour le traitement dans le module interne, les sorties attendues et les conditions d'erreur qui peuvent être rencontrées pendant le traitement.

Les commentaires fournissent également souvent des informations sur l'auteur du contenu, la date et l'heure de son développement ainsi que la date et l'heure de sa dernière modification. La quantité de détails à inclure est une question de subjectivité. Certains développeurs sont connus pour détester les commentaires et les considèrent comme une perte de temps. Pour d'autres, les commentaires sont une nécessité absolue. En théorie, une organisation devrait établir toutes ses normes de codage. Pourtant, pour une raison quelconque, quiconque a hérité du code d'une équipe de développement précédente vous dira plus souvent qu'autrement que le code n'a pas les commentaires qu'ils aimeraient voir.