Javadoc Javadoc permet la création d'une documentation de vos travaux, au format HTML, avec liens... La encore (cohérence du langage Java !!), l'idée est.

Présentation au sujet: "Javadoc Javadoc permet la création d'une documentation de vos travaux, au format HTML, avec liens... La encore (cohérence du langage Java !!), l'idée est."— Transcription de la présentation:

1 Javadoc Javadoc permet la création d'une documentation de vos travaux, au format HTML, avec liens... La encore (cohérence du langage Java !!), l'idée est d'intégrer directement dans le source des commentaires qui permettront la création automatique de cette documentation. On peut noter que Java lui même a été écrit en utlisant ce principe, la documentation a donc été générée automatiquement par l'application de Javadoc sur les sources de Java (voir http://java.sun.com/j2se/1.5.0/docs/api/) http://java.sun.com/j2se/1.5.0/docs/api/ Afin d'offrir le choix entre ce qui sera publié, et ce qui restera pour le programmeur, Java utilise une forme particulière de commentaire, avec deux étoiles au lieu d'une... exemple : /* ceci est un commentaire pour les lecteurs du code source*/ /** Ceci est un commentaire qui sera * publié*/

2 JavaDoc les Mots Clefs Dans un commentaire JavaDoc, vous pouvez utiliser des mots clefs (précédés de @) qui déclencheront des liens, des rappels, ou des mises en avant de ce que vous avez balisé. Ces mots cléfs sont par exemple : /** une petite liste de mots clés author * @author moi * @version 1.7 * @see “l'excellent doc de mon ami Robert” * * @ param date_Naissance * @param prix le prix du transport * Ici, le commentaire précise le rôle du paramètre prix * * @return Vrai ou Faux, selon la disponibilité */

3 Exemple dans le source package panier; /** * La classe Produit telle que vous devez la convevoir. * @version 1.0 * @author sylvain * @see "Documentation sur JavaDoc et JUnit" * @see Site */ public class Produit { /** le nom du produit*/ private String nom; /** le prix du produit*/ private double prix; /**la quantité, gérée dans la classe*/ private int qte_en_stock; /** Contructeur complet * * @param lenom Nom du produit * @param leprix Le prix du produit * @param laquant La quantité en stock à l'instanciation */ public Produit(String lenom, double leprix, int laquant) {....... }

4 Eclipse – Projet/générer Javadoc

5 Des précisions Quelques points à noter : ● Il est conseillé de mettre une étoile en début de chaque ligne du commentaire Javadoc. ● La documentation est générée au format HTML, avec hyperliens (sous Eclipse, vous utiliserez Projet / Générer Javadoc, et un nouveau répertoire doc apparaitra dans votre projet...) Vous pourrez copier ensuite ces pages html dans un serveur WEB. ● Le commentaire Javadoc est toujours placé JUSTE AVANT la classe, le paramètre, la méthode qu'il décrit. ● Eclipse peut générer les commentaires JavaDoc, notamment avec les getters et les setters... ● Eclipse vous affiche la documention lors du survol de souris sur une Classe, ou l'appel d'une méthode ● La page racine s'appelle index.html