Au risque de me répéter :
Un jour, un bon programmeur m'a dit : "Un bon code propre n'a pas besoin de commentaire".
Si ce que tu fais est suffisamment clair, le langage en lui même est assez parlant.
D'ailleurs j'ai déjà perdu des points pour avoir mis trop de commentaires en partiel.
Dans la pratique, je met en début de chaque fonction (juste avant) son rôle et ses paramètres (syntaxe doxygen/javadoc). Le but étant de savoir ce que fait la fonction sans avoir à la relire.
Ensuite, je met des commentaires lorsqu'un bout de code n'est pas trivial.
Mais pour revenir sur ce que je disais au début, lorsque tu trouves que ton commentaire est inutile et que ton code est suffisamment clair sans, alors n'en met pas.
Je préfère lire un code peu commenté mais compréhensible qu'un code avec pleins de commentaires mais dont je ne comprend pas l'implémentation (ie avec des noms de variables pourris, mal découpé en fonctions, etc.)
# Commentaires
Posté par Maxime (site web personnel) . En réponse au message Commentaires dans le code. Évalué à 2.
Un jour, un bon programmeur m'a dit : "Un bon code propre n'a pas besoin de commentaire".
Si ce que tu fais est suffisamment clair, le langage en lui même est assez parlant.
D'ailleurs j'ai déjà perdu des points pour avoir mis trop de commentaires en partiel.
Dans la pratique, je met en début de chaque fonction (juste avant) son rôle et ses paramètres (syntaxe doxygen/javadoc). Le but étant de savoir ce que fait la fonction sans avoir à la relire.
Ensuite, je met des commentaires lorsqu'un bout de code n'est pas trivial.
Mais pour revenir sur ce que je disais au début, lorsque tu trouves que ton commentaire est inutile et que ton code est suffisamment clair sans, alors n'en met pas.
Je préfère lire un code peu commenté mais compréhensible qu'un code avec pleins de commentaires mais dont je ne comprend pas l'implémentation (ie avec des noms de variables pourris, mal découpé en fonctions, etc.)