donner des exemples aux fonctions simples (ce qui permet de voir ce que fait une fonction, sans avoir a lire son code !)
Non, pour ça tu fais des tests unitaires. Les commentaires se déprécient facilement, les tests unitaires ne mentent pas.
donner des liens croisés : vers d'autres parties du code quand cela permet d'aller plus vite (ou est la classe XXXX qui utilise ce bout de code que je regarde ?), ou des urls pour expliquer un truc compliqué (on évite de laisser le lecteur sans explication)
Pareil trop complexe à mettre à jour c'est le boulot d'un outil qui va analyser le code. Tu peut mettre des grands principes en commentaire (par module par exemple), mais pas de qui utilise quoi comment.
Tous les contenus que j'écris ici sont sous licence CC0 (j'abandonne autant que possible mes droits d'auteur sur mes écrits)
[^] # Re: Les commentaires c'est bien
Posté par barmic . En réponse au sondage Les commentaires et vous ?. Évalué à 4.
Non, pour ça tu fais des tests unitaires. Les commentaires se déprécient facilement, les tests unitaires ne mentent pas.
Pareil trop complexe à mettre à jour c'est le boulot d'un outil qui va analyser le code. Tu peut mettre des grands principes en commentaire (par module par exemple), mais pas de qui utilise quoi comment.
Tous les contenus que j'écris ici sont sous licence CC0 (j'abandonne autant que possible mes droits d'auteur sur mes écrits)