Moi, je ne commente que l'entête des fonctions de la façon suivante :
- Ce que doit faire la fonction
- Les paramêtres non triviaux,
- La valeur de retour.
- Et les conditions d'utilisations (base de données ouvertes, structures) pour que la fonction s'exécute bien.
Éventuellement, je rajoute les exceptions qui risquent d'être levées.
Commenter le code à l'intérieure de la fonction, c'est nul. Parce que :
1) lors de mise à jour du code, les commentaires n'ont pas d'obligation à être remis à jour. dans la réalité, ils ne le sont pas.
2) C'est le signe d'une mauvaise conception.
3) c'est chiant à faire.
# Moi même
Posté par Putifuto . En réponse au message Commentaires dans le code. Évalué à 4.
- Ce que doit faire la fonction
- Les paramêtres non triviaux,
- La valeur de retour.
- Et les conditions d'utilisations (base de données ouvertes, structures) pour que la fonction s'exécute bien.
Éventuellement, je rajoute les exceptions qui risquent d'être levées.
Commenter le code à l'intérieure de la fonction, c'est nul. Parce que :
1) lors de mise à jour du code, les commentaires n'ont pas d'obligation à être remis à jour. dans la réalité, ils ne le sont pas.
2) C'est le signe d'une mauvaise conception.
3) c'est chiant à faire.
voilà pour moi.