salut tout le monde, je voudrais produire la documentation de mon projet et d'après mes recherches j'ai trouvé Doxygen mais il y a aussi La Javadoc .. J'utilise le quel ? (rapide, clair, et facile a gérer)
Version imprimable
salut tout le monde, je voudrais produire la documentation de mon projet et d'après mes recherches j'ai trouvé Doxygen mais il y a aussi La Javadoc .. J'utilise le quel ? (rapide, clair, et facile a gérer)
En parlant de Java, la Javadoc sans hésiter.
La forme est bien établie dans l'univers Java et la facilité d'utilisation également. En outre, il est possible de greffer des plugins permettant d'ajouter diverses fonctionnalités.
Je confirme que la javadoc est préférable. Elle a l'énorme avantage de faire partie de Java, donc :
- tous les utilisateurs de java doivent avoir l'habitude de l'organisation de la javadoc.
- c'est parfaitement adapté aux spécificités du langage java.
- ça évite d'ajouter une application supplémentaire.
Pour avoir utilisé les deux pour du java, je trouve Doxygen un poil mieux foutu, proposant un multitude d'options supplémentaires à ce que apporte la javadoc standard (genre intégration du code avec coloration syntaxique dans la doc, index de recherche un poil plus rapide, graphes de dépendances inter classes/méthodes si couplé avec Graphviz et plein d'autres choses plutôt utiles), donc je dirait doxygen.
Sachant que Doxygen supporte les commentaires javadoc standard.
Par contre la javadoc est un outil standard et que les devs java on l'habitude d'utiliser. Tout dépend de ce que est attendu. J'aurais tendance à privilégier Doxygen quand même.
D'autant plus que Doxygen permet de sortir la doc sous différents formats (HTML, CHM, postscript, PDF ...). C'est juste que la plupart des javaïstes ne connaissent pas ce merveilleux outil ;).
Pour un exemple (assez vieux, l'outil est encore meilleur à l'heure actuelle) de ce que donne Doxygen avec du java: http://cyberzoide.developpez.com/jav...doc/index.html
La Javadoc peut aller se rhabiller :mouarf:
Et aussi pour Doxygen, ne pas oublier d'utiliser Doxywizard et Graphviz
Bah, la javadoc a également ce genre de plugins externes...
Pardon de rouvrir ce vieux débat. Mais si il est possible d'ajouter toutes les fonctionalités à Javadoc alors je dis javadoc aussi. Pardon sinok, mais pour le moment Doxygen connaît diverses incompatibilité avec javadoc. Notamment ceci :
Je cite ces probleme pour les avoir rencontré moi-même.Citation:
I am not an expert on doxygen but here are a couple of things that have been pointed out me by users:
Make sure that you use the doxygen comment style for suffix comments and single line comments.
Use @link @endlink instead of {@link .. }.The HTML <blockquote> construct is not supported by doxygen so use it warily.trouvé sur cette page
Plus les caractères accentués qui ne passe pas même quand on choisi la langue 'French'. Et je n'ai pas encore tout vu mais il doit certainement y en avoir d'autres.
J'ai donc pu constater encore d'autres bugs. C'est sûr, doxygen is not fully compatible avec JavaDoc surtout les annotations entre accolade. Un plus génant est l'annotation {@code } du JDK 1.5 dont la syntaxe ressemble beaucoup à celle de doxygen mais doit se finir par \endcode.
Eh oui doxygen est un outil très puissant :aie: que je trouve d'ailleurs génial mais il reste quelques problemes à résoudre pour être utilisable sur les sources annotées en javadoc !!! C'est vraiment dommage surtout si on a beaucoup de sources déjà documentées en javadoc.:(
Affaire à suivre.
Par contre si vous connaissez des plugins sur javadoc pour faire la même chose qu'avec doxygen je suis preneur.