Table des matières:
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 raison principale d'inclure des commentaires dans les langages de programmation est d'améliorer la portabilité et la maintenabilité d'un code.
Techopedia explique comment
Souvent, les équipes de développement logiciel travaillent ensemble sur différents modules logiciels, qui sont inspectés par les 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, le développeur inclut des commentaires 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 concernant l'auteur du contenu, la date et l'heure de son élaboration et 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 de fois que le code n'a pas le commentaire qu'il aurait aimé voir.
