Javadoc

Documentation Java
Javadoc
Javadoc est un outil développé par Sun Microsystems permettant de créer une
documentation d'API en format HTML depuis les commentaires présents dans un code
source en Java. Javadoc est le standard industriel pour la documentation des classes Java.
La plupart des IDEs créent automatiquement le javadoc HTML.
Tags Javadoc
Les développeurs utilisent certains styles de commentaire et des tags Javadoc quand ils
documentent un code source. Un bloc de commentaire java commençant par /**
deviendra un bloc de commentaire Javadoc qui sera inclus dans la documentation du code
source. Les commentaires Javadoc précèdent généralement les déclarations de classes,
d'attributs et de méthodes, il est également possible de décrire un paquetage, en créant
un fichier package-info.java dans le dossier correspondant, dans lequel on inclut un
commentaire Javadoc.
Tag
Description
@author
Nom du développeur
@exception
Documente une exception lancée par une méthode — voir aussi @throws.
@param
Définit un paramètre de méthode. Requis pour chaque paramètre.
@return
Documente la valeur de retour. Ce tag ne devrait pas être employé pour des constructeurs ou
des méthodes définis avec un type de retour void.
@see
Documente une association à une autre méthode ou classe.
@since
Précise à quelle version de la SDK/JDK une méthode a été ajoutée à la classe.
@throws
Documente une exception lancée par une méthode. Un synonyme pour @exception
disponible depuis Javadoc 1.2.
@version
Donne la version d'une classe ou d'une méthode.
Exemple d'utilisation de Javadoc pour documenter une méthode :
/**
* Valide un mouvement de jeu d'Echecs.
* @param srcFile File de la pièce à déplacer
* @param srcRangee Rangée de la pièce à déplacer
* @param dstFile File de la case de destination
* @param dstRangee Rangée de la case de destination
* @return true si le mouvement d'échec est valide ou false si invalide
*/
boolean estUnDeplacementValide(int srcFile, int srcRangee, int dstFile, int dstRangee)
{
...
}
Un exemple d'utilisation de Javadoc pour documenter une classe :
/**
* Classe de gestion d'étudiants
* @author John Doe
* @version 2.6
*/
public class Etudiant
{
...
}