Un code bien écrit et des noms de fonctions explicites sont généralement suffisants. Il y a deux cas où les commentaires sont indispensables :
- pour documenter une api publique (l'utilisateur ne lira pas le source -> doxygen ou équivalent)
- pour expliquer des astuces et des algorithmes (ex: "on utilise la technique des lapins roses, ... description ..." ou "il faut appeler cette fonction pour éviter un trou noir"
En dehors de ça, le code ça se lit comme l'anglais ou le chinois, il suffit de savoir lire (et que l'écrivain soit bon).
# Commentaires indispensables
Posté par peck (site web personnel) . En réponse au message Commentaires dans le code. Évalué à 8.
- pour documenter une api publique (l'utilisateur ne lira pas le source -> doxygen ou équivalent)
- pour expliquer des astuces et des algorithmes (ex: "on utilise la technique des lapins roses, ... description ..." ou "il faut appeler cette fonction pour éviter un trou noir"
En dehors de ça, le code ça se lit comme l'anglais ou le chinois, il suffit de savoir lire (et que l'écrivain soit bon).