Introduction à la javadoc

Introduction Exemples Création javadoc
Javadoc
Création de documention en Java
1 / 20
Cours Java - F. Michel

Introduction Exemples Création javadoc
Plan
1Introduction à la Javadoc
2Exemples
3Création javadoc : ligne de commande / Eclipse
2 / 20
Cours Java - F. Michel

Introduction Exemples Création javadoc
Introduction Javadoc
Le programme javadoc
javadoc est le 3e programme essentiel fourni avec le SDK (java, javac).
C’est l’outil qui sert à générer la documentation au format de Sun (API).
Il permet donc à un tiers d’utiliser vos programmes et vos librairies de
manière simple et efficace.
Cela permet aussi au programmeur de s’y retrouver plus rapidement !
Utiliser cet outil est fondamental pour programmer en Java.
Les commentaires pour la javadoc : /** . . . */
/**
* documentation pour méthode/classe/attributs/paramètres/etc.
*/
4 / 20
Cours Java - F. Michel

Introduction Exemples Création javadoc
Exemple de javadoc
Personne.java
package cours . jav adoc ;
/∗ ∗
∗La class e personne modelise une personne .
∗E l l e s e r t pour . . .
∗
∗@see NegativeAgeException
∗@author fab
∗/
p u b l i c class Personne implements Cloneable {
/∗ ∗
∗l ’ age de l a personne , d o i t e t r e p o s i t i f
∗/
p r i v a t e i n t age ;
/∗ ∗
∗l e nom de l a perso nn e , une s im p le c ha in e de c a r a t e r e s
∗/
private S t r i n g name ;
6 / 20
Cours Java - F. Michel

Introduction Exemples Création javadoc
Exemples
Personne.java
/∗ ∗
∗C on s tru c teu r p our l a cl asse Personne .
∗Blabla . . .
∗
∗@param age un e n t i e r >= 0
∗@param name l e nom de l a personne
∗@throws Negat iveAgeException s i age < 0
∗/
public Personne ( int age , S t r i n g name ) t hrows NegativeAgeException {
t h i s . setAge ( age ) ;
t h i s . name = name ;
}
7 / 20
Cours Java - F. Michel