Un code qui a besoin de documentation est souvent un code qui a besoin d'un bon refactoring : reorganiser, diviser en sous-fonctions/methodes, mieux nommer les variables. Si le code n'est pas toujours bien a jour, les commentaires ne le sont quasiment jamais. Pour citer le bouquin clean code : "les commentaires mentent". Dont je recommande par ailleurs la lecture.
Le commentaire doit etre occasionnel, indispensable et justifie (les commentaires auto en Java sur les getters/setters sont justes inutiles...). Le manque de temps pour ameliorer le code n'etant pas une justification ;). Si c'est du code rapide et jetable, il doit pouvoir etre jete, et ne pas devenir vital...
# Code auto-documente
Posté par isildur37 . En réponse au sondage Les commentaires et vous ?. Évalué à 2.
Un code qui a besoin de documentation est souvent un code qui a besoin d'un bon refactoring : reorganiser, diviser en sous-fonctions/methodes, mieux nommer les variables. Si le code n'est pas toujours bien a jour, les commentaires ne le sont quasiment jamais. Pour citer le bouquin clean code : "les commentaires mentent". Dont je recommande par ailleurs la lecture.
Le commentaire doit etre occasionnel, indispensable et justifie (les commentaires auto en Java sur les getters/setters sont justes inutiles...). Le manque de temps pour ameliorer le code n'etant pas une justification ;). Si c'est du code rapide et jetable, il doit pouvoir etre jete, et ne pas devenir vital...