D'expérience (professionnelle), les commentaires ne sont jamais mis à jour en même temps que le code. Ils sont donc généralement faux.
Notons par ailleurs qu'aucun compilateur (de ma connaissance) ne vérifie que les commentaires sont exacte. J'en ai vu de nombreux qui décrivait autre chose que le code correspondant. (cf le titre)
J'en ai déduit qu'on doit trouver en commentaire la fonction d'un programme/fonction, la description de ses paramètres et valeurs de retour, des exceptions, bugs et limites. Eventuellement une référence à l'algorithme utilisé si c'est pas évident.
MAIS surtout JAMAIS de description du code.
Si c'est bien codé, c'est lisible.
# if (i = 0) // je vérifie que i est égal à 0
Posté par bertrand . En réponse au journal à quand un code commenté ?. Évalué à 6.
Notons par ailleurs qu'aucun compilateur (de ma connaissance) ne vérifie que les commentaires sont exacte. J'en ai vu de nombreux qui décrivait autre chose que le code correspondant. (cf le titre)
J'en ai déduit qu'on doit trouver en commentaire la fonction d'un programme/fonction, la description de ses paramètres et valeurs de retour, des exceptions, bugs et limites. Eventuellement une référence à l'algorithme utilisé si c'est pas évident.
MAIS surtout JAMAIS de description du code.
Si c'est bien codé, c'est lisible.