JavadocJavadoc
Capture d'écran de la javadoc de Java SE 11
Javadoc est un outil développé par Oracle, permettant de créer une documentation d'API en format HTML depuis les commentaires présents dans un code source en Java. Conçu à l'origine par Sun MicroSystems (avant son rachat par Oracle), javadoc est le standard industriel pour la documentation des classes Java. La plupart des IDE génèrent automatiquement la javadoc au format HTML. Tags JavadocLorsqu'ils commentent le code-source, les développeurs Java peuvent signaler qu'un commentaire doit être intégré dans la documentation à l'aide d'une syntaxe spéciale. Un bloc de commentaire Java commençant par Un tag Javadoc commence par une
ExempleUn exemple d'utilisation de Javadoc pour documenter une méthode : /**
* Valide un mouvement de jeu d'Echecs.
* @param leDepuisFile File de la pièce à déplacer
* @param leDepuisRangée Rangée de la pièce à déplacer
* @param leVersFile File de la case de destination
* @param leVersRangée Rangée de la case de destination
* @return vrai (true) si le mouvement d'échec est valide ou faux (false) sinon
*/
boolean estUnDeplacementValide(int leDepuisFile, int leDepuisRangée, int leVersFile, int leVersRangée)
{
...
}
Un exemple d'utilisation de Javadoc pour documenter une classe : /**
* Classe de gestion d'étudiants
* @author John Doe
* @version 2.6
*/
public class Etudiant
{
...
}
Javadoc fournit également une API pour créer des doclets et des taglets, qui permettent d'analyser la structure d'une application de Java. C'est grâce à cela que JDiff peut produire des rapports de ce qui a changé entre deux versions d'une API. Toutefois, le concept ne permet de produire la doc de l'API que dans une seule langue. Notes et référencesAnnexesArticles connexesLiens externes |
