Je continue une série de billets consacrés aux idées reçues débutée ici.
Tu codes mal tu n’as pas mis de commentaire
Un code fortement commenté n’est pas une propriété d’un bon code, au contraire. C’est souvent le signe d’un manque d’expressivité et de lisibilité du code. La seule documentation perpétuellement à jour est le code lui même.
Les commentaires sont mauvais car :
- ils sont voués à être obsolètes,
- ils brouillent la lecture du code,
- on perd du temps à les écrire, à les formuler correctement.
C’est seulement quand on échoue à rendre le code explicite que l’on doit s’autoriser à ajouter un commentaire. Et cela doit être rare.
Une astuce pour supprimer progressivement les commentaires superflus est d’utiliser le refactoring Extract Method. (Vous noterez au passage la suppression du commentaire dans l’exemple du refactoring).