« Programmation Java/Commentaires » : différence entre les versions
Contenu supprimé Contenu ajouté
une page essentielle qui manquait au livre |
|||
Ligne 62 :
=== Documentation ===
Le JDK fournit un outil nommé javadoc qui permet de générer la documentation des classes correctement commentées.
La commande javadoc sans argument donne la syntaxe complète de la commande.
Exemple : pour une [[Programmation Java/Les classes en Java|classe]] nommée <tt>Exemple</tt> définie dans un ''[[Programmation Java/Extensions|package]]'' nommé <tt>org.wikibooks.fr</tt> dans le fichier <tt>C:\ProgJava\org\wikibooks\fr\Exemple.java</tt> :
<source lang="java">
package org.wikibooks.fr;
/**
Une classe d'exemple.
*/
public class Exemple
{
/**
Obtenir la somme de deux entiers.
@param a Le premier nombre entier.
@param b Le deuxième nombre entier.
@return La valeur de la somme des deux entiers spécifiés.
*/
public int somme(int a, int b)
{
return a+b;
}
}
</source>
La documentation peut être générée dans un répertoire spécifique (C:\ProgDoc par exemple) avec la commande suivante :
javadoc -locale fr_FR -use -classpath C:\ProgJava -sourcepath C:\ProgJava -d C:\ProgDoc org.wikibooks.fr
Les options de cette commande sont décrits ci-dessous :
;<tt>-locale fr_FR</tt>:La documentation est en français.
;<tt>-use</tt>:Créer les pages sur l'utilisation des classes et paquetages (''packages'').
;<tt><nowiki>-classpath C:\ProgJava</nowiki></tt>:Le chemin des classes compilées (*.class).
;<tt><nowiki>-sourcepath C:\ProgJava</nowiki></tt>:Le chemin des classes sources (*.java).
;<tt><nowiki>-d C:\ProgDoc</nowiki></tt>:Le chemin où la documentation doit être générée.
;<tt>org.wikibooks.fr</tt>:Le nom du paquetage (''package'') à documenter. Il est possible de spécifier un nom de classe pour ne documenter que celle-ci.
La page de description d'un paquetage copie le texte de description à partir d'un fichier nommé <tt>package.html</tt> qui doit se situer dans le répertoire correspondant. Dans notre exemple, il faut documenter le paquetage dans le fichier <tt>C:\ProgJava\org\wikibooks\fr\package.html</tt>.
| |||