TP1
JAVA DOC :
La génération de documentation Java se fait par le menu "Project->Generate javadoc...". Ne vous pré-occupez pas de la plupart des options proposées pour le moment et avancez jusqu'à la génération des pages HTML.
Javadoc peut interpréter des commentaires spécifiques introduits dans le code source pour enrichir la documentation générée. Ces commentaires se situent juste avant la déclaration d'une classe, d'un attribut ou d'une méthode. Ils commencent par /** et se terminent par */. Ces commentaires contiennent une partie textuelle libre et des tags interprétés pour certains commentaires spécifiques.
Quelques tags fréquemment utilisés * @author : l'auteur d'une classe * @version : le numero de version d'une classe * @see : une référence à une classe ou un membre d'une classe intéressant pour la classe ou la méthode commentée * @param x : Une description du paramètre d'entrée x d'une méthode * @return : Une description de la valeur renvoyée par une méthode
Exemple de classe commentée pour javadoc package bibliotheque;
/**
* Cette classe est utilisée pour représenter un livre.
*
* @author Hafidi IMAD
*/
public class Livre extends Produit {

/** * Le titre du livre */ private String titre;

/** * L'auteur du livre */ private String auteur;

/** * Le constructeur de la classe Livre * * @param tit Le titre du livre * @param aut L'auteur du livre */ public Livre(String tit, String aut) { titre = tit; auteur = aut; }

/** * Cette méthode renvoie une chaîne de caractères qui décrit * textuellement le livre (par son titre, son auteur et l'éditeur) * * @return Une chaîne de caractère décrivant le livre */ public String description() { return "\""+titre+"\" de "+auteur+" edite par