Java/Annexe/Documenter un programme
Une page de Wikiversité.
 |
|||
| Annexe 3 | |||
| Leçon : Java |
|---|
En raison de limitations techniques, la typographie souhaitable du titre, « Java — Annexe : Documenter un programme
Java/Annexe/Documenter un programme », n'a pu être restituée correctement ci-dessus.
Il existe trois types de commentaires en Java :
- commentaires sur une ligne. Ils débutent par « // » et s'arrêtent à la fin de la ligne ;
- commentaires sur une ou plusieurs lignes. Ils débutent par « /* » et se terminent par « */» ;
- commentaires Javadoc, sur une ou plusieurs lignes. Ils commencent par « /** » et se terminent par « */ ».
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 internet comme par exemple Firefox.
Sommaire |
[modifier] Installation
Lorsque vous installez le JDK de Sun, vous installez aussi, sans peut-être le savoir aussi « Javadoc ».
[modifier] 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
/** * bla bla .... * bla bla ... */
[modifier] Les mots-clés
Certains mots-clés ont une signification particulière, ils sont précédés par "@"
- author
- deprecated
- exception
- override
- param
- return
- since
- see
- serial
- serialData
- serialField
- throws
- version
[modifier] 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 ».
