Tu confonds commentaires et documentation.
Oui en effet... et c'est volontaire. En fait je pensais à Java quand j'ai écrit ça mais je pense que ces deux notions sont intimement liés. Tout simplement parce premièrement, il faudra bien écrire la documentation à un moment ou un autre et que le plus simple c'est de la générer automatiquement à partir des commentaires du code source ; c'est d'ailleurs la réponse que j'ai donnée au sondage.
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.
Bien sûr mais :
1 - c'est parfois très complexe et donc très long
2 - c'est pratique de savoir ce qu'à voulu faire le programmeur pour éviter le célèbre : c'est une feature ou un bug ?
C'est la deuxième raison qui m'incite à mettre la documentation dans les commentaires : celui qui lit le code, parce qu'il contribue/dévermine/reprend le projet, en a aussi besoin.
Ceci devrait rester exceptionnel si on fait du code de manière suffisamment explicite
J'abonde dans ton sens.
[^] # Re: Je commente mon code :
Posté par jcs (site web personnel) . En réponse au sondage Je commente mon code :. Évalué à 1.
Oui en effet... et c'est volontaire. En fait je pensais à Java quand j'ai écrit ça mais je pense que ces deux notions sont intimement liés. Tout simplement parce premièrement, il faudra bien écrire la documentation à un moment ou un autre et que le plus simple c'est de la générer automatiquement à partir des commentaires du code source ; c'est d'ailleurs la réponse que j'ai donnée au sondage.
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.
Bien sûr mais :
1 - c'est parfois très complexe et donc très long
2 - c'est pratique de savoir ce qu'à voulu faire le programmeur pour éviter le célèbre : c'est une feature ou un bug ?
C'est la deuxième raison qui m'incite à mettre la documentation dans les commentaires : celui qui lit le code, parce qu'il contribue/dévermine/reprend le projet, en a aussi besoin.
Ceci devrait rester exceptionnel si on fait du code de manière suffisamment explicite
J'abonde dans ton sens.