Je suis bien au courant. Quasiment tous les projets java utilisent ce principe. Cela dit, avec asciidoctor par exemple, on devrait pouvoir externaliser cette documentation. Ça fait sens si on veut la traduire et même documenter à partir des tests, des exemples de code tiré du git, présent dans d'autres fichiers.
Je veux bien documenter une classe, au dessus du code de celle-ci, car ça ne gêne pas la lecture du code. Par contre documenter toutes les méthodes est une perte de temps, surtout lorsque ça paraît triviale. La doc inline qui explique un passage complexe est bien sûr primordial.
[^] # Re: No comment
Posté par YBoy360 (site web personnel) . En réponse au journal Toileharicot 12 est dehors. Évalué à 2. Dernière modification le 19 août 2020 à 20:40.
Je suis bien au courant. Quasiment tous les projets java utilisent ce principe. Cela dit, avec asciidoctor par exemple, on devrait pouvoir externaliser cette documentation. Ça fait sens si on veut la traduire et même documenter à partir des tests, des exemples de code tiré du git, présent dans d'autres fichiers.
Je veux bien documenter une classe, au dessus du code de celle-ci, car ça ne gêne pas la lecture du code. Par contre documenter toutes les méthodes est une perte de temps, surtout lorsque ça paraît triviale. La doc inline qui explique un passage complexe est bien sûr primordial.