Génération de la documentation avec javadoc

La Javadoc permet d'écrire la documentation des méthodes du programme directement dans le code. Un programme va ensuite générer un site pour afficher toute cette documentation.

package labo6;

class JourDeLaSemaine { 
      /**
    	 * Adapte la longueur d'une chaîne de caractères en la complétant par des
    	 * caractères espace ou en réduisant son nombre de caractères.
    	 * 
    	 * @param chaine  la chaîne de caractères à ajuster.
    	 * @param largeur La largeur que doit avoir la chaîne de caractères spécifiée.
    	 * @return La chaîne de caractères ajustée.
    	 */
    	public static String ajusterLargeur(String chaine, int largeur) {
    		final int LG_CHAINE = chaine.length();
    		chaine = (LG_CHAINE > largeur) ? chaine.substring(0, largeur) : chaine;
    		return chaine + " ".repeat(largeur - chaine.length());
    	}
}

Dans l'exemple ci dessus, on a une méthode "ajusterLargeur" que l'on veut documenter. Pour se faire il suffit d'écrire /** puis enter dans Eclipse pour que le template soit généré tout seul.

Dans la première partie on écrit la description de la méthode, puis on décrit à quoi correspondent chaque paramètre et ce que la méthode retourne.

Pour générer la Javadoc par la suite on peut aller sur Eclipse dans le menu "Project" puis "Generate javadoc". La javadoc sera ainsi générée dans le dossier doc du projet.

Et voici le résultat pour notre méthode :