Un commentaire est placé au sein du code et sert juste à clarifier le code quand celui-ci n'est pas assez parlant. Ceci devrait rester exceptionnel si on fait du code de manière suffisamment explicite (25 lignes max par fonction, noms de variables/fonctions explicites, variables intermédiaires quand besoin (c'est optimisé par le compilo/interpréteur la plupart du temps), etc.).
La documentation sert à fournir des informations aux personnes qui ne veulent/peuvent pas lire le code source.
Plus elle est complète et mieux c'est.
Les questions que tu te poses en voyant get_date() relèvent de la documentation. Si tu regardes le code, celui-ci doit être assez clair pour répondre à tes questions.
Après, je suis d'accord que certains langages mettent la documentation au milieu du code (comme la javadoc), mais on distingue quand même les deux (les commentaires sont d'ailleurs présentés différemment dans ce but) et dans le cas de la javadoc on peut produire une doc externe.
[^] # Re: Je commente mon code :
Posté par davux . En réponse au sondage Je commente mon code :. Évalué à 3.
Un commentaire est placé au sein du code et sert juste à clarifier le code quand celui-ci n'est pas assez parlant. Ceci devrait rester exceptionnel si on fait du code de manière suffisamment explicite (25 lignes max par fonction, noms de variables/fonctions explicites, variables intermédiaires quand besoin (c'est optimisé par le compilo/interpréteur la plupart du temps), etc.).
La documentation sert à fournir des informations aux personnes qui ne veulent/peuvent pas lire le code source.
Plus elle est complète et mieux c'est.
Les questions que tu te poses en voyant get_date() relèvent de la documentation. Si tu regardes le code, celui-ci doit être assez clair pour répondre à tes questions.
Après, je suis d'accord que certains langages mettent la documentation au milieu du code (comme la javadoc), mais on distingue quand même les deux (les commentaires sont d'ailleurs présentés différemment dans ce but) et dans le cas de la javadoc on peut produire une doc externe.