Je trouve que des bons commentaires, c'est un vrai bonheur.
Pour ma part, deux règles simples :
- donner des exemples aux fonctions simples (ce qui permet de voir ce que fait une fonction, sans avoir a lire son code !)
- 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)
Pensez à celui qui relit votre code (souvent, c'est vous-mêmes, 6 mois plus tard).
# Les commentaires c'est bien
Posté par zappa_eguy . En réponse au sondage Les commentaires et vous ? . Évalué à 7.
Je trouve que des bons commentaires, c'est un vrai bonheur.
Pour ma part, deux règles simples :
- donner des exemples aux fonctions simples (ce qui permet de voir ce que fait une fonction, sans avoir a lire son code !)
- 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)
Pensez à celui qui relit votre code (souvent, c'est vous-mêmes, 6 mois plus tard).
Ahem, heu, voila.