Je connais bien Javadoc, et je sais bien qu'il s'agit de la documentation d'une API.. c'est même ce que je dis dans mon 1er message. Normalement si il s'agit d'une API, c'est vrai que le code est trivial par nature. De plus les IDE proposent d'afficher le Javadoc au survole de la méthode...
Asciidoctor permet déjà de mettre des extraits de code à partir d'un numéro de commit et un numéro de ligne. On pourrait appliquer ce principe pour commenter une API.
Avantages : i18n, documentation API composite, enrichie aux extraits de code des tests venant des sources pour montrer l'usage de l'API, documentation structurée.
Si on a pas besoin de tout ça, juste d'une documentation de l'API, c'est difficile de faire mieux que les Javadoc like, je te l'accorde.
[^] # Re: No comment
Posté par YBoy360 (site web personnel) . En réponse au journal Toileharicot 12 est dehors. Évalué à -1.
Je connais bien Javadoc, et je sais bien qu'il s'agit de la documentation d'une API.. c'est même ce que je dis dans mon 1er message. Normalement si il s'agit d'une API, c'est vrai que le code est trivial par nature. De plus les IDE proposent d'afficher le Javadoc au survole de la méthode...
Asciidoctor permet déjà de mettre des extraits de code à partir d'un numéro de commit et un numéro de ligne. On pourrait appliquer ce principe pour commenter une API.
Avantages : i18n, documentation API composite, enrichie aux extraits de code des tests venant des sources pour montrer l'usage de l'API, documentation structurée.
Si on a pas besoin de tout ça, juste d'une documentation de l'API, c'est difficile de faire mieux que les Javadoc like, je te l'accorde.