des programmmes pour générer leur documentation ?
Présentation
Exemple de déclaration de classe
Exemple de déclaration de méthode
Ce document décrit le formatage et les conventions utilisées pour les commentaires dans les sources Java pouvant ressortir sous forme de page HTML .
Pour générer votre page HTML décrivant les classes utilisées dans vos
fichiers :
javadoc -d <répertoire ou générer la
documentation> -private <nom du package ou du fichier>
Suivant la syntaxe utlisée dans vos commentaires, vous pouvez les faire
ressortir dans les pages HTML .
Pour la majorité, il faut commencer les commentaires par /** avant la
déclaration des classes, des méthodes & attributs , puis continuer avec une
"*" par ligne en n'oubliant pas de terminer par */
Exemple :
/**
* Inode du fichier ouvert
*/
public Inode inode;
| /** * Classe Descripteur . Il s'agit d'une representation d'un fichier ouvert . On dispose de * l'inode du fichier, le numero de bloc courant et la position dans ce bloc, mise à jour * lors des des dernieres operations d'entree/sortie. <br> * * Les instances de la classe Descripteur sont ranges dans un instance de la classe * Processus * * @see System_file.Processus */ public class Descripteur { |
résultat
après javadoc Pour
faire un lien vers une autre classe : @see <nom_package>.<nom_classe>
| /** * Constructeur : Cree un descripteur pointant sur le fichier ouvert, a niveau * du premier bloc de données * * @param i Inode du fichier à ouvrir * @param no_d Numero du descripteur */ public Descripteur(Inode i,int no_d, Super_bloc s) |
résultat après
javadoc Pour
faire apparaitre les nom de paramètres : @param <nom_parametre> <description>
Pour faire apparaître la valeur de retour :@return <description de la valeur retournée>