Documenter une application Java
Résolu
Bonjour,
J'ai développé une application java, et je veux la documenter, pour être facile à utiliser et facile à améliorer.
S'il vous plaît dites moi comment puis-je faire cela ?
Cordialement.
J'ai développé une application java, et je veux la documenter, pour être facile à utiliser et facile à améliorer.
S'il vous plaît dites moi comment puis-je faire cela ?
Cordialement.
1 réponse
-
ModérateurBonjour,
Java est un langage autodocumenté grâce à la commande javadoc, cela permet de générer automatiquement une documentation standardisée, à partir de commentaires placés directement dans le code source.
Voici par exemple la Javadoc de l'API Java 7 :
https://docs.oracle.com/javase/7/docs/api/-
-
Modérateur@HichamistoIl y a deux manières principales de partager la javadoc.
1. Mettre le site web généré en ligne, cela permet de naviguer facilement dans la documentation, comme avec le lien que je t'ai donné sur l'api.
2. Packager le site web dans un jar (ou un zip, je ne sais plus) que tu mets à disposition en complément de ta bibliothèque. On peut alors configurer son IDE pour aller chercher la documentation dans ce jar et ainsi voir la description des classes et méthodes de ta bibliothèque au fur et à mesure de leur utilisation.
Sur le même principe tu peux mettre à disposition le code source dans un troisième jar, ce qui permet éventuellement d'avoir plus d'informations lors du debogage ou sur les traces des exceptions par exemple.
Remarque : il faudrait tester mais je pense que si tu as un jar avec le code source (et donc les annotations de documentation dedans) il n'est plus utile d'avoir le jar avec la documentation, l'IDE est suffisamment intelligent pour s'y retrouver. Mais il vaut mieux laisser le développeur choisir en lui proposant toutes les possibilités. -
-
