Académique Documents
Professionnel Documents
Culture Documents
Javadoc
Création de documention en Java
Cours Java - F. Michel
1 / 20
Introduction Exemples Création javadoc
Plan
1 Introduction à la Javadoc
2 Exemples
Introduction Javadoc
Le programme javadoc
javadoc est le 3e programme essentiel fourni avec le SDK (java, javac).
Exemple de javadoc
Personne.java
Exemples
Personne.java
/∗∗
∗ C o n s t r u c t e u r pour l a c l a s s e Personne .
∗ Blabla . . .
∗
∗ @param age un e n t i e r >= 0
∗ @param name l e nom de l a personne
∗ @throws NegativeAgeException s i age < 0
∗/
p u b l i c Personne ( i n t age , S t r i n g name ) throws NegativeAgeException {
t h i s . setAge ( age ) ;
t h i s . name = name ;
}
Exemples
Personne.java
/∗∗
∗ M o d i f i e l ’ age de l a personne .
∗
∗ @param age un e n t i e r >= 0
∗ @throws NegativeAgeException s i age < 0
∗/
p u b l i c v o i d setAge ( i n t age ) throws NegativeAgeException {
i f ( age < 0 ) {
throw ( new NegativeAgeException ( " e r r e u r : l ’ age d o i t e t r e > 0 , "
+ " v a l e u r e n t r e e : " +age ) ) ; / / s o r t de l a methode
}
t h i s . age = age ;
}
Exemples
Personne.java
@Override
/∗∗
∗ cree une r e p r e s e n t a t i o n sous forme de s t r i n g de l ’ o b j e t
∗ personne
∗ @return une chaine de c a r a c t e r e s
∗/
public String toString () {
r e t u r n name+ " age : " +age ;
}
}
Exemples
NegativeAgeException.java
/∗∗
∗ E x c e pt i o n generee l o r s d ’ une mauvaise
∗ u t i l i s a t i o n de l a methode { @link Personne#setAge ( i n t ) } .
∗
∗ @author f a b
∗ @see Personne
∗/
p u b l i c c l a s s NegativeAgeException extends E x c ep t i o n {
/∗∗
∗ c o n s t r u c t e u r pour l ’ e x c e p t i o n
∗ @param message l e message d ’ e r r e u r
∗/
p u b l i c NegativeAgeException ( S t r i n g message ) {
super ( message ) ;
}
}
package-info.java
/∗∗
∗ Give t h e summary o f what t h e package a l l o w s t o do .
∗ And more d e t a i l s here . b l a b l a . . .
∗
∗ @since P r o j e c t 1 . 0
∗ @author f a b
∗ @version 1 . 1
∗
∗/
package cours . javadoc ;
En ligne de commande :
option -sourcepath : racine des sources (= packages)
option -d : répertoire destination
arguments : noms de package (prog.nompackage) et/ou noms de fichiers
.java
Exemple
Exemple
Résultat
Sous Eclipse
File → Export → Javadoc →
Sous Eclipse
→ Next
Sous Eclipse
→ Next
plus d’information