Comment générer des fichiers HTML Javadoc dans Eclipse?
J'ai écrit des commentaires de style Javadoc comme celui-ci dans le code de mon projet:
/**
* Description...
*
* @param ...
* @return .....
*/
Comment générer des fichiers HTML Javadoc à l'aide de l'IDE Eclipse?
Project > Generate Javadoc....
Dans le Javadoc command: champ, parcourez pour trouver javadoc.exe (généralement à [path_to_jdk_directory]\bin\javadoc.exe).
Cochez la case en regard du projet/package/fichier pour lequel vous créez la Javadoc.
Dans le Destination: Dans ce champ, parcourez pour rechercher la destination souhaitée (par exemple, le répertoire racine du projet en cours).
Cliquez sur Finish.
Vous devriez maintenant pouvoir trouver le Javadoc nouvellement généré dans le dossier de destination. Ouvrez index.html.
Ceci est une réponse complémentaire liée au PO:
Une solution simple et fiable pour ajouter des commentaires Javadocs dans Eclipse:
- Aller à Help > Eclipse Marketplace....
- Trouvez "JAutodoc".
- Installez-le et redémarrez Eclipse.
Pour utiliser cet outil, cliquez avec le bouton droit sur la classe et cliquez sur JAutodoc.
Vous pouvez également le faire en ligne de commande très facilement.
- Ouvrez la ligne de commande à partir du dossier/package.
Depuis la ligne de commande:
javadoc VotreNomClass.Java
Pour générer par lots des documents pour plusieurs classes:
javadoc * .Java
Pour ajouter rapidement un 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.