Puis-je ajouter JavaDoc à un paquet facilement avec Eclipse ?

Question

J'utilise javadoc pour documenter mes classes et méthodes. J'aimerais également ajouter des informations générales à mes paquets. J'aime la manière dont Eclipse crée un stub d'un commentaire Doc correspondant pour chaque classe ou méthode une fois que j'ai tapé /**<Enter> . Est-ce qu'Eclipse dispose d'un moyen simple de générer un fichier de type fichier package.html aussi ?

Answer 1

Mise à jour 4 ans plus tard (oct. 2013)

javabeangrinder 's réponse (upvoted) mentionne l'astuce suivante :

Pour créer un package-info.java dans un paquet existant :

• Cliquez à droite sur le paquet où vous voulez un package-info.java .
• Sélectionnez new->package .
• Vérifiez le Create package.info.java la case à cocher.
• Cliquez sur Finish

---

Réponse originale (mai 2009)

Il n'existe pas de modèle ou d'assistant permettant de créer facilement un fichier package.html.

Comme mmyers a déclaré dans son commentaire, puisque Java1.5 le fichier correct à créer serait package-info.java .
Ce fichier peut être utilisé non seulement pour des javadocs, mais aussi pour des annotations au niveau du paquet (comme illustré ici ).

Il existe un bogue ouvert (#86168) pour avoir exigé un assistant pour la création de package-info.java (depuis l'assistant de classe ne permet pas le package-info nom ).

Les réflexions sur ce sujet sont en cours depuis... 2005 ! Le problème est que toute solution doit être mise en œuvre de manière à ce qu'elle aide également à 1.4 code.

La solution de contournement actuelle consiste à créer un package-info.java en tant que text fichier.
À partir de ce moment-là, package-info.java se comporte comme une classe Java normale, et Eclipse place une balise package-info.class dans le dossier de sortie.
Le site Javadocs sont correctement construits en utilisant package-info.java et non le package.html fichier.

_{(source : <a href="http://jmdoudoux.developpez.com/cours/developpons/java/images/jaxb006.png" rel="nofollow noreferrer">developpez.com </a>)}

---

Note (en réponse à Fraise ) :

• bogue 77451 (2004 !, pour package.html)
• bogue 163633 y bogue 163926 (2006, pour package-info.java)

les deux souhaite a aperçu de la vue d'ensemble du paquet dans package-info.java dans la Javadoc vue d'ensemble .

Jusqu'à présent, aucun correctif n'a été proposé/mis en œuvre.
Il n'y a tout simplement pas assez de demandes pour que cette fonctionnalité soit ajoutée.

Answer 2

En éclipse

Puisque package-info.java n'est pas un identifiant valide pour une classe, il ne peut pas être créé comme une classe dans Eclipse.

J'ai découvert que lorsque vous créez un nouveau paquet, il y a une case à cocher pour vérifier si vous voulez un package-info.java.

Pour créer un fichier package-info.java dans un paquet existant :

1. Faites un clic droit sur le paquet où vous voulez un package-info.java.
2. Sélectionnez nouveau->package.
3. Cochez la case Créer un paquet.info.java.
4. Cliquez sur Terminer

Answer 3

El JAutodoc fait un excellent travail à cet égard, ainsi que pour tous vos autres besoins de documentation. Installez et configurez le plugin, puis faites un clic droit sur le paquet et cliquez sur JAutodoc > Ajouter un paquet Javadoc

Il existe des configurations et des modèles disponibles pour le .java o .html la documentation du paquet.

Ce plugin fait également un excellent travail de standardisation de tous vos besoins en matière de Javadoc, avec une grande possibilité de personnalisation.

http://jautodoc.sourceforge.net/

Answer 4

Il y a un plugin qui semble créer des fichiers package.html. Je ne l'ai pas utilisé mais quelqu'un qui atterrit ici pourrait le trouver utile.

http://sourceforge.net/projects/package-javadoc/