CodeS-SourceS
Rechercher un code, un tuto, une réponse

Créer de la javadoc

Juin 2017


Créer de la javadoc

Qu'est ce que c'est ?


La javadoc est une documentation normalisée du code qui permet de générer une documentation au format html du code .

La documentation officielle se trouve sur le site d'oracle : http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Comment la produire ?


L'exemple ci dessous vous montre ce qu'il faut écrire pour obtenir une javadoc minimale et exploitable.


Dans un programme java, la javadoc est entourée de /** */

Toutes les possibilités ne sont pas abordées dans le but de rester assez simple.

/**
 * Exemple est la classe qui définit un exemple de javadoc
 * Cette classe est caractérisée par les informations suivantes :
 * <ul>
 * <li>Description fonctionnelle de l'attribut 1</li>
 * <li>Description fonctionnelle de l'attribut 2</li>
 * </ul>
 * Description des principales fonctionnalités de la classe
 * </p>
 * Description complémentaire, sur les attributs statiques par exemple
 * </p>
 * @author nom de l'auteur
 * @version numéro de version
 */
public class Exemple { 

    /** 
     * Description de l'attribut 1 
     */
    private String attribut1; 

    /** 
     * Description de l'attribut 2 
     */ 
    private int attribut2; 

    /** 
     * <b>Constructeur de Exemple</b> 
     * 
     * Informations complémentaires éventuelles. Sur le constructeur 
     * parent utilisé par exemple. 
     * 
     * @param attribut1 
     *     Description de l'attribut 1 
     * @param attribut2 
     *     Description de l'attribut 2 
     */ 
    public Exemple(String attribut1, int attribut2) { 
        this.attribut1 = attribut1; 
        this.attribut2 = attribut2; 
    } 

    /** 
     * Description de l'utilité de la méthode 
     * @param ex 
     *     description du paramètre en entrée 
     * @return description de la sortie 
     * @throws InterruptedException 
     *     description des raisons de la propagation de l'exception 
     */ 
    public int methodeExemple(String ex) throws InterruptedException { 
        return 0; 
    } 
} 

Exporter la javadoc


Pour exporter la javadoc, on fait un click droit sur le projet ou la classe à exporter, puis on clique sur exporter.

On choisit alors un dossier de destination et on renseigne la commande javadoc à exécuter. C'est le chemin vers le programme javadoc.exe qui se trouve dans le jdk.

On clique enfin sur exporter.


La log affiche alors :


Building index for all classes...
Generating D:\doc\allclasses-frame.html...
Generating D:\doc\allclasses-noframe.html...
Generating D:\doc\index.html...
Generating D:\doc\help-doc.html...
Generating D:\doc\stylesheet.css...

Et la javadoc se trouve dans le dossier spécifié :
D:\uploadedFiles\yql730WW35sIkNuIkMb5pMy_ZjOKOTNyoIdBaKD_YEiS8_I\doc\Exemple.html - skip-navbar_top

A voir également

Publié par cs_Julien39.
Ce document intitulé «  Créer de la javadoc  » issu de CodeS-SourceS (codes-sources.commentcamarche.net) est mis à disposition sous les termes de la licence Creative Commons. Vous pouvez copier, modifier des copies de cette page, dans les conditions fixées par la licence, tant que cette note apparaît clairement.
Récupérer la trace d'une erreur sans ide
Démarrage rapide avec NetBeans IDE