Le code auto-documenté, c'est surtout une excuse à la con pour justifier quelque chose dont on devrait avoir honte (à savoir ne pas ecrire de commentaires). Un code a toujours besoin de documentation/commentaire, ne serait ce que pour indiquer le role des fonctions, pour expliciter une astuce ou un truc pas evident à voir. Jamais j'utiliserais une librairie qui n'a pas un minimum de doc expliquant en detail chacune des methodes disponibles. Apres peut etre qu'il y en a qui aiment le risque : vous le paierez un jour.
J'ai jamais vu "in real life" des commentaires du style "j'initialise x à 3", et pour les getters/setters quen j'ai vu commentés, c'etait à chaque fois l'edi qui generait ce code : pourquoi prendre ces exemples bidons pour justifier quelque chose qui en devrait pas l'etre ?
Quant aux commentaires qui mentent, malheureusement il y en a. Est ce que pour autant, on doit jeter le bebe avec l'eau du bain ?
HS : j'aime beaucoup la police de l'image, quelqu'un a une idée de son nom ?
[^] # Re: Code auto-documente
Posté par patapon . En réponse au sondage Les commentaires et vous ?. Évalué à 3.
Le code auto-documenté, c'est surtout une excuse à la con pour justifier quelque chose dont on devrait avoir honte (à savoir ne pas ecrire de commentaires). Un code a toujours besoin de documentation/commentaire, ne serait ce que pour indiquer le role des fonctions, pour expliciter une astuce ou un truc pas evident à voir. Jamais j'utiliserais une librairie qui n'a pas un minimum de doc expliquant en detail chacune des methodes disponibles. Apres peut etre qu'il y en a qui aiment le risque : vous le paierez un jour.
J'ai jamais vu "in real life" des commentaires du style "j'initialise x à 3", et pour les getters/setters quen j'ai vu commentés, c'etait à chaque fois l'edi qui generait ce code : pourquoi prendre ces exemples bidons pour justifier quelque chose qui en devrait pas l'etre ?
Quant aux commentaires qui mentent, malheureusement il y en a. Est ce que pour autant, on doit jeter le bebe avec l'eau du bain ?
HS : j'aime beaucoup la police de l'image, quelqu'un a une idée de son nom ?