Ton commentaire est pertinent de mon point de vue, le cas que tu décris (celui du débutant qui a besoin de commentaires « évidents » pour s'aider) est un cas réel, et oui, dans ce cas c'est logique (et parfois nécessaire) d'écrire des commentaires qui paraissent triviaux. Le cas est simplement hors du propos du billet, qui ne concerne que ce qui respecte la directive en en-tête : « Les utilisateurs de votre code, savent lire le code ».
Donc, en tant que débutant, tu n'as pas à te sentir concerné par ce billet. Au contraire : si mettre des commentaires, quels qu'ils soient, te permettent de mieux comprendre ce que tu fais et de t'y retrouver quelques mois plus tard, vas-y.
Idem pour le code que qui est fait pour soi et qui ne sera jamais partagé, là tu fais bien ce que tu veux (même si tu violes toutes les « bonnes pratiques » du langage), c'est ton problème et ne concerne que toi.
Mon billet concerne les cas de travail en équipe, en particulier dans un contexte professionnel (ou assimilé, dans le sens ou les acteurs ont normalement tous les compétences pour lire du code). Là, même s'il y a quelques « débutants » dans l'équipe, tout le monde est censé avoir un niveau minimum et surtout devenir rapidement opérationnel, au point de ne plus avoir besoin de commentaires tautologiques. Le billet part aussi du principe que, dans les faits, personne n'aime écrire des commentaires, et que c'est d'autant plus dommage de perdre du temps dans un truc qui n'a aucune valeur ajoutée.
Bon l'article,le énième sur le sujet , en lui même n'as pas beaucoup d’intérêt : les exemples de commentaires inutiles sont caricaturaux et aucun exemple de commentaire utile.
Au risque de te surprendre, les deux exemples de commentaires inutiles sont des exemples réels de code en production... Oui, on trouve des gens qui trouvent encore utile de rédiger de tels commentaires (ou de les auto-générer), et pire, de demander à leurs collègues de faire de même.
Quant aux exemples de commentaires « utiles », en fait c'est difficile à donner sans devenir très verbeux. Mais si tu as des exemples à fournir, je serais heureux de les intégrer au billet.
[^] # Re: Heu...
Posté par SpaceFox (site web personnel, Mastodon) . En réponse au lien Mort aux commentaires inutiles ! Écrivez des commentaires pertinents !. Évalué à 6. Dernière modification le 17 décembre 2022 à 20:23.
Coucou, c'est l'auteur du billet ici :)
Ton commentaire est pertinent de mon point de vue, le cas que tu décris (celui du débutant qui a besoin de commentaires « évidents » pour s'aider) est un cas réel, et oui, dans ce cas c'est logique (et parfois nécessaire) d'écrire des commentaires qui paraissent triviaux. Le cas est simplement hors du propos du billet, qui ne concerne que ce qui respecte la directive en en-tête : « Les utilisateurs de votre code, savent lire le code ».
Donc, en tant que débutant, tu n'as pas à te sentir concerné par ce billet. Au contraire : si mettre des commentaires, quels qu'ils soient, te permettent de mieux comprendre ce que tu fais et de t'y retrouver quelques mois plus tard, vas-y.
Idem pour le code que qui est fait pour soi et qui ne sera jamais partagé, là tu fais bien ce que tu veux (même si tu violes toutes les « bonnes pratiques » du langage), c'est ton problème et ne concerne que toi.
Mon billet concerne les cas de travail en équipe, en particulier dans un contexte professionnel (ou assimilé, dans le sens ou les acteurs ont normalement tous les compétences pour lire du code). Là, même s'il y a quelques « débutants » dans l'équipe, tout le monde est censé avoir un niveau minimum et surtout devenir rapidement opérationnel, au point de ne plus avoir besoin de commentaires tautologiques. Le billet part aussi du principe que, dans les faits, personne n'aime écrire des commentaires, et que c'est d'autant plus dommage de perdre du temps dans un truc qui n'a aucune valeur ajoutée.
Au risque de te surprendre, les deux exemples de commentaires inutiles sont des exemples réels de code en production... Oui, on trouve des gens qui trouvent encore utile de rédiger de tels commentaires (ou de les auto-générer), et pire, de demander à leurs collègues de faire de même.
Quant aux exemples de commentaires « utiles », en fait c'est difficile à donner sans devenir très verbeux. Mais si tu as des exemples à fournir, je serais heureux de les intégrer au billet.
La connaissance libre : https://zestedesavoir.com