« Java/Annexe/Documenter un programme » : différence entre les versions
Contenu supprimé Contenu ajouté
maintenance |
m Robot : Remplacement de texte automatisé (-\n(==={0,3})(?: *)([^\n=]+)(?: *)\1(?: *)\n +\n\1 \2 \1\n) |
||
Ligne 15 :
Les commentaires javadoc permettent des créer grâce à une petite commande une documentation en HTML. Cette documentation est donc consultable à l'aide d'un navigateur Web comme par exemple Firefox.
== Installation ==
Lorsque vous installez le JDK de Sun, vous installez aussi, peut-être sans le savoir, « Javadoc ».
== Commentez ==
Vous pouvez commenter une classe, un champ ou une méthode. Les commentaires se trouvent juste au dessus de ce que vous voulez commenter et utilisent la syntaxe
Ligne 28 :
*/
== Les mots-clés ==
Certains mots-clés ont une signification particulière, ils sont précédés par "@"
Ligne 45 :
* version
== Générer la documentation ==
Pour générer la documentation, tapez « javadoc MonProgramme.java ». Remplacez bien sûr « MonProgramme » par le nom de votre programme. Par défaut, javadoc ne génére la documentation pour les commentaires au-dessus d'une méthode ou d'un champ possédant le modificateur « private ».
| |||