A mon sens, et je te rejoins, il ne faut jamais faire de commentaires pour explique ce que fait ton code. Si tu en arrives là, c'est que tu as pondu un monstre immaintenable.
Par contre, je rajoute souvent des commentaires pour expliquer pourquoi mon code fait ceci ou cela, et cela prend généralement place dans l'entête de la fonction.
Exemple "mauvais" :
fopen();
// début de la boucle
while (!eof()) {
list.add(readln());
// ligne suivante
next();
} // while (!eof())
fclose();
Tous ces commentaires sont totalement inutiles, et le lecteur n'en sait pas plus grâce à eux. Le seul qui soit un petit peu défendable, c'est le "// while ..." qui, pour ceux qui n'ont pas un IDE moderne, permet de se retrouver ; et encore, il faut surtout éviter un trop grand nombre d'imbrications.
Un truc comme ça :
/**
* Chargement du fichier dans une liste de chaînes pour
* pouvoir ensuite appeler une méthode standard de tri
*/
fopen();
while(!eof()) {
list.add(readln());
next();
}
Est bien plus utile. Le lecteur n'a pas besoin de parcourir tout le code pour savoir ce que ça fait, le commentaire apporte un vrai plus sur le code par une vision globale.
[^] # Re: commenter le code?
Posté par Dring . En réponse au journal à quand un code commenté ?. Évalué à 10.
fopen(); // début de la boucle while (!eof()) { list.add(readln()); // ligne suivante next(); } // while (!eof()) fclose();Tous ces commentaires sont totalement inutiles, et le lecteur n'en sait pas plus grâce à eux. Le seul qui soit un petit peu défendable, c'est le "// while ..." qui, pour ceux qui n'ont pas un IDE moderne, permet de se retrouver ; et encore, il faut surtout éviter un trop grand nombre d'imbrications. Un truc comme ça :/** * Chargement du fichier dans une liste de chaînes pour * pouvoir ensuite appeler une méthode standard de tri */ fopen(); while(!eof()) { list.add(readln()); next(); }Est bien plus utile. Le lecteur n'a pas besoin de parcourir tout le code pour savoir ce que ça fait, le commentaire apporte un vrai plus sur le code par une vision globale.