Comment générer des fichiers HTML Javadoc dans Eclipse ?

Question

J'ai écrit des commentaires de style Javadoc comme celui-ci dans le code de mon projet :

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

Comment puis-je générer des fichiers HTML Javadoc à l'aide de l'IDE Eclipse ?

Answer 1

1. Project > Generate Javadoc... .

2. Dans le Javadoc command: champ, parcourir pour trouver javadoc.exe (généralement à [path_to_jdk_directory] \bin\javadoc.exe ).

3. Cochez la case à côté du projet/package/fichier pour lequel vous créez la Javadoc.

4. Dans le Destination: parcourez le champ pour trouver la destination souhaitée (par exemple, le répertoire racine du projet en cours).

5. Cliquez sur Finish .

Vous devriez maintenant être en mesure de trouver le Javadoc nouvellement généré dans le dossier de destination. Ouvrez index.html .

Answer 2

Il s'agit d'une réponse complémentaire liée à l'OP :

Une solution facile et fiable pour ajouter des commentaires Javadocs dans Eclipse :

1. Aller à Help > Eclipse Marketplace... .
2. Trouvez "JAutodoc".
3. Installez-le et redémarrez Eclipse.

Pour utiliser cet outil, faites un clic droit sur la classe et cliquez sur JAutodoc .

Answer 3

Vous pouvez également le faire à partir de la ligne de commande beaucoup plus facilement.

1. Ouvrir la ligne de commande à partir du dossier/package.

2. Depuis la ligne de commande, exécutez :

   javadoc VotreNomDeClasse.java

3. Pour générer des documents par lots pour plusieurs classes :

   javadoc *.java

Answer 4

Pour ajouter rapidement une Javadoc, utilisez le raccourci suivant :

Windows : alt + shift + J

Mac : + Alt + J

Selon le contexte sélectionné, une Javadoc sera imprimée. Pour créer une Javadoc écrite par OP, sélectionnez la méthode correspondante et appuyez sur les touches de raccourci.