C'est bien beau ça, mais là on sait juste qu'on passe sur toutes les faces, on ne sait pas quel traitement on fait dessus, et c'est pour ça qu'un commentaire serait bienvenu juste au dessus du for, pour dire voire expliquer quel traitement on fait.
En fait il faudrait commenter non pas pour dire ce que chaque ligne fait, mais ce que chaque bloc de 3-4 lignes fait, en une phrase simple.
Exemple pas bon :
/* mettre 5 dans l'age de toto */
toto.age = 5;
/* mettre "toto" dans le nom de toto */
toto.nom = "toto"
Exemple bon :
/* preparer les donnees de la fiche de toto */
toto.age = 5;
toto.nom = "toto"
Cela dit, il est évident que des noms de variable bien choisis aident énormément à la relecture du code. Et il ne faut pas avoir peur d'utiliser des longs noms de variable/fonction, ne jamais les abréger, ça les rend illisible !
Exemple pas bon :
/* initialise l'age de toto */
sta(age);
Exemple bon :
/* initialise l'age de toto et calcule l'annee de naissance */
set_toto_age(age);
Ici, les commentaires peuvent en plus informer l'utilisateur sur un traitement que fait la fonction et qui ne transparait pas de façon évidente dans le nom de la fonction, même si cela reste logique par rapport au traitement.
# Re: çà sert a rien les commentaires
Posté par Florent C. . En réponse au journal çà sert a rien les commentaires. Évalué à 1.
C'est bien beau ça, mais là on sait juste qu'on passe sur toutes les faces, on ne sait pas quel traitement on fait dessus, et c'est pour ça qu'un commentaire serait bienvenu juste au dessus du for, pour dire voire expliquer quel traitement on fait.
En fait il faudrait commenter non pas pour dire ce que chaque ligne fait, mais ce que chaque bloc de 3-4 lignes fait, en une phrase simple.
Exemple pas bon :
/* mettre 5 dans l'age de toto */
toto.age = 5;
/* mettre "toto" dans le nom de toto */
toto.nom = "toto"
Exemple bon :
/* preparer les donnees de la fiche de toto */
toto.age = 5;
toto.nom = "toto"
Cela dit, il est évident que des noms de variable bien choisis aident énormément à la relecture du code. Et il ne faut pas avoir peur d'utiliser des longs noms de variable/fonction, ne jamais les abréger, ça les rend illisible !
Exemple pas bon :
/* initialise l'age de toto */
sta(age);
Exemple bon :
/* initialise l'age de toto et calcule l'annee de naissance */
set_toto_age(age);
Ici, les commentaires peuvent en plus informer l'utilisateur sur un traitement que fait la fonction et qui ne transparait pas de façon évidente dans le nom de la fonction, même si cela reste logique par rapport au traitement.