Leçons de niveau 14

Java/Annexe/Documenter un programme

Une page de Wikiversité.
Sauter à la navigation Sauter à la recherche
Documenter un programme
Image logo représentative de la faculté
Annexe 1
Leçon : Java

Annexe de niveau 14.

Précédent :Sommaire
Suivant :Nombres
Icon falscher Titel.svg
En raison de limitations techniques, la typographie souhaitable du titre, « 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 :

  1. commentaires sur une ligne. Ils débutent par « // » et s'arrêtent à la fin de la ligne ;
  2. commentaires sur une ou plusieurs lignes. Ils débutent par « /* » et se terminent par « */» ;
  3. 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 Web comme par exemple Firefox.

Installation[modifier | modifier le wikicode]

Lorsque vous installez le JDK de Sun, vous installez aussi, peut-être sans le savoir, « Javadoc ».

Commentez[modifier | modifier le wikicode]

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 ...
*/

Les mots-clés[modifier | modifier le wikicode]

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

Générer la documentation[modifier | modifier le wikicode]

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 ».