Documentation Javadoc

L'outil Javadoc fourni avec le JDK permet de documenter les classes et les méthodes de ces classes. On place ces commentaires juste avant la déclaration de la classe ou de la méthode en utilisant les commentaires de documentation qui sont délimités par /** et */.

Ces commentaires spéciaux seront donc reconnus par l'outil javadoc inclus dans le JDK et celui-ci va pouvoir générer de la documentation au format HTML comme celle que l'on retrouve sur le site de Sun à propos des classes de la librairie standard Java.

Il va donc falloir respecter certaines règles, une syntaxe précise qui sera reconnue par Javadoc afin de générer une documentation adéquate.

Description

La première chose que l'on met pour un commentaire de classe ou de méthode, c'est une courte description en langue naturelle de l'entité documentée. Voici un exemple de description pour une classe qui offre une méthode permettant de calculer la moyenne entre deux entiers.