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

165

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?

java eclipse javadoc JaneNY
la source
renvoyer ceci. learnjava-soa.blogspot.com/2015/06/…
madhu

Réponses:

234

  1. Project> Generate Javadoc....

  2. Dans le Javadoc command:champ, recherchez javadoc.exe (généralement dans [path_to_jdk_directory] \ bin \ javadoc.exe ).

  3. Cochez la case en regard du projet / package / fichier pour lequel vous créez le Javadoc.

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

  5. Cliquez sur Finish.

Vous devriez maintenant pouvoir trouver le Javadoc nouvellement généré dans le dossier de destination. Ouvrez index.html .

Renu P
la source
1
Le JDK Java doit-il être installé? J'ai installé Java et je peux créer des programmes Java dans Eclipse ... mais javadoc.exen'existe nulle part sur mon lecteur!
AlainD
Ancien, mais pour toute personne à l'avenir qui pourrait être confuse à ce sujet, vérifiez si le JDK est installé par opposition au JRE (qui ne contient pas javadoc.exe à cet emplacement).
omoshiroiii
9

Voici une réponse complémentaire liée au PO:

Une solution simple 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.

pionnierBhawna
la source
7
AFAIK, JAutodoc ne génère pas de HTML à partir des commentaires javadoc existants (ce que la question demande), mais aide plutôt à générer les commentaires javadoc.
Amani Kilumanga
3
La réponse n'est pas liée à la question, mais c'est exactement ce que je cherchais :)
keya
Eclipse vous permettra de générer des Javadocs: Projet -> Générer des Javadocs ...
pongapundit
Cela ne générera que javadoc et non le html, qui est de quoi il s'agit.
Ashish
5

Vous pouvez également le faire à partir de la ligne de commande très facilement.

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

  2. À partir de la ligne de commande, exécutez:

    javadoc YourClassName.java

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

    javadoc * .java

Sean Das
la source
2

Pour ajouter rapidement un Javadoc, utilisez le raccourci suivant:

Windows : alt+ shift+J

Mac : ⌘+ Alt+J

En fonction du contexte sélectionné, un Javadoc sera imprimé. Pour créer Javadoc écrit par OP, sélectionnez la méthode correspondante et appuyez sur les touches de raccourci.

Jacob van Lingen
la source