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 puis-je générer des fichiers HTML Javadoc à l'aide de l'E Eclipse?
5 answers
Projet > Générer La Javadoc....
Dans le Javadoc de commande: champ, trouvez javadoc.exe (généralement à [path_to_jdk_directory]\bin\javadoc.exe ).
Cochez la case à côté du projet / package / fichier pour lequel vous créez le Javadoc.
Dans le champ Destination:, recherchez la destination souhaitée (par exemple, le répertoire racine du projet).
Cliquez Sur Finition.
Vous devriez maintenant être en mesure de trouver le Javadoc nouvellement généré dans le dossier de destination. Ouvrir index.html .
Comment générer Javadoc dans Eclipse?
Ouvrez le dossier du projet Eclipse.
Sélectionnez Projet > Générer La Javadoc....
-
À la première étape de l'assistant, vous pouvez définir les paramètres:
3.1. Sélectionnez le chemin pour le javadoc.exe outil du JDK.
3.2. Ressources du projet pour lesquelles générer Javadoc.
3.3. Classes et méthodes pour lesquelles générer Javadoc basé sur leur visibilité.
3.4. Emplacement du Javadoc (par défaut, il sera placé dans le dossier doc dans l'emplacement du projet).
-
À la deuxième étape, vous pouvez effectuer des réglages concernant:
4.1. Titre du document.
4.2. Structure de la documentation.
4.3. Sélectionnez les balises de document à traiter.
4.4. Autres ressources (archives, projets) utilisées dans le projet à inclure dans la documentation.
4.5. Sélectionnez CSS feuille de style pour votre documentation.
- À la dernière étape, vous pouvez enregistrer les paramètres dans un script Ant pour une utilisation future.
Ceci est une réponse complémentaire liée à l'OP:
Une solution simple et fiable pour ajouter des commentaires Javadocs dans Eclipse:
- Aller à Aide > Eclipse Marketplace....
- Trouver "JAutodoc".
- Installez-le et redémarrez Eclipse.
Pour utiliser cet outil, faites un clic droit sur class et cliquez sur JAutodoc.
Vous pouvez également le faire à partir de la ligne de commande beaucoup plus facilement.
- Ouvrez la ligne de commande à partir du dossier/paquet.
-
À Partir de la ligne de commande exécuter:
Javadoc YourClassName.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 + maj + J
Mac: ⌘ + Alt + J
Selon le 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 shotcut.