Lors de la programmation sur un ordinateur, il est parfois nécessaire de laisser des notes ou des commentaires afin que d'autres développeurs puissent parcourir votre code avec facilité. Qu'il s'agisse d'un projet open source ou d'un projet propriétaire, les commentaires sont nécessaires afin de se coordonner avec les co-développeurs et les futurs développeurs potentiels. Sans commentaires, le code serait tout simplement impossible à maintenir.
Pas
Étape 1. Comprendre le but de commenter un programme informatique
- La lisibilité est l'élément clé ici. Lorsque vous regardez un commentaire, vous devez savoir qu'il s'agit d'un commentaire et non d'une ligne de code.
- Le commentaire devrait également être utile non seulement pour vous, mais pour toute autre personne susceptible de lire le code source de votre programme informatique.
Étape 2. Pensez à un moyen simple et court de faire passer votre message
Les commentaires n'ont pas besoin d'être une œuvre d'art. Ils doivent être concis, soignés et aller droit au but.
Cela ne doit cependant pas décourager l'utilisation de plusieurs lignes pour un commentaire. Le fait est que l'information doit être transmise au lecteur
Étape 3. Écrivez le commentaire en utilisant la syntaxe appropriée donnée par le langage de programmation
Étape 4. Demandez-vous si le commentaire que vous avez écrit est suffisamment détaillé
Un commentaire devrait pouvoir dire à quelqu'un qui regarde le code source ce que fait réellement cette partie du programme sans avoir à le compiler et à l'exécuter. Votre commentaire y parvient-il ? Transmet-il tous les détails ?
