Documenter une application Java
Résolu/Fermé
Hichamisto
Messages postés
52
Date d'inscription
jeudi 26 juin 2014
Statut
Membre
Dernière intervention
4 juillet 2017
-
Modifié par Hichamisto le 4/08/2014 à 20:32
Hichamisto Messages postés 52 Date d'inscription jeudi 26 juin 2014 Statut Membre Dernière intervention 4 juillet 2017 - 6 août 2014 à 20:52
Hichamisto Messages postés 52 Date d'inscription jeudi 26 juin 2014 Statut Membre Dernière intervention 4 juillet 2017 - 6 août 2014 à 20:52
A voir également:
- Documenter une application Java
- Application mobile - Guide
- Waptrick java football - Télécharger - Jeux vidéo
- Jeux java itel football - Télécharger - Jeux vidéo
- Application java - Télécharger - Langages
- Désinstaller une application sur pc - Guide
1 réponse
KX
Messages postés
16753
Date d'inscription
samedi 31 mai 2008
Statut
Modérateur
Dernière intervention
25 novembre 2024
3 019
4 août 2014 à 22:05
4 août 2014 à 22:05
Bonjour,
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/
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/
6 août 2014 à 14:58
déjà le problème est résolu mais juste une autre question s'il vous plait :
comment un simple utilisateur ou un développeur peut bénéficier de ma documentation ?
6 août 2014 à 20:18
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.
6 août 2014 à 20:52
Je vous remercie vivement et infiniment.
Bien cordialement.