J'utilise javadoc pour documenter mes classes et méthodes. Je voudrais également ajouter des informations de synthèse à mes packages. J'aime comment Eclipse crée un bout d'un commentaire de Doc correspondant pour chaque classe ou méthode une fois que je tape /**<Enter>. Est-ce que Eclipse a aussi un moyen facile de générer un package.html file?Puis-je ajouter facilement JavaDoc à un package avec Eclipse?
Mise à jour 4 ans plus tard (oct 2013)
javabeangrinder « s answer (upvoted) mentionne l'astuce suivante:
Pour créer un fichier
package-info.javadans un package existant:
package-info.java.new->package.Create package.info.java.Finishréponse originale (mai 2009)
Il n'y a pas de modèle ou assistant pour créer facilement un fichier package.html. Comme mmyers a déclaré dans son commentaire, depuis Java1.5, le fichier correct à créer serait package-info.java.
Ce fichier peut être utilisé non seulement pour javadocs, mais également pour package-level annotations (comme illustrated here).
Il y a un opened Bug (#86168) pour exiger un assistant pour la création de package-info.java (depuis l'assistant de classe ne permet pas le nom package-info).
Les réflexions sur ce sujet sont en cours depuis ... 2005! Le problème est que toute solution devrait être implémentée d'une manière qui aide également avec le code 1.4.
La solution de contournement actuelle consiste à créer un package-info.java en tant que fichier text. À partir de ce moment, package-info.java se comporte comme une classe Java normale et Eclipse place un fichier package-info.class dans le dossier de sortie.
Les Javadocs sont correctement construits en utilisant package-info.java, et non le fichier package.html.
alt text http://jmdoudoux.developpez.com/cours/developpons/java/images/jaxb006.png
Note (en réponse aux commentaires de Strawberry):
deux souhait un aperçu de la vue d'ensemble du paquet dans package-info.java dans la Javadoc vue.
Jusqu'à présent, aucun correctif n'a été proposé/implémenté.
Il n'y a tout simplement pas assez de demandes pour que cette fonctionnalité soit ajoutée.
Y a-t-il un moyen d'afficher le package javadocs dans la fenêtre d'affichage rapide de Javadoc? faire pour les classes, les interfaces et les méthodes? – Martin
@Strawberry: non, aucune vue Javadoc pour package-info.java. Voyez ma réponse détaillée à ce sujet. – VonC
Note à moi-même, après [cette question] (http://stackoverflow.com/a/9600531/6309), je dois traverser plus de 200K * à nouveau *! (en raison de certains [rep recalc] (http://meta.stackexchange.com/questions/125121/has-reputation-for-deleted-posts-been-removed-again)) – VonC
Il y a un plugin qui semble créer des fichiers package.html. Je ne l'ai pas utilisé mais quelqu'un atterrissant ici pourrait le trouver utile.
Le plug-in JAutodoc fait un excellent travail de cela, ainsi que tous vos autres besoins de documentation. Installer et configurer le plug-in et clic droit sur le package et cliquez sur JAutodoc> Ajouter un package Javadoc
Il existe des configurations et des modèles disponibles pour la documentation du paquet .java ou .html.
Ce plugin fait également un excellent travail de standardisation de tous vos besoins Javadoc, avec beaucoup de personnalisation.
éclipse
Depuis package-info.java n'est pas un identifiant valide pour une classe, il ne peut être créé en tant que classe dans Eclipse.
J'ai trouvé que lorsque vous créez un nouveau paquet il y a une case à cocher pour vérifier si vous voulez un paquet-info.java.
Pour créer un fichier package-info.java dans un package existant:
Haha c'est tellement intuitif, merci :) Ça ne répond pas à la question, mais ça m'a aidé! –
+1. [À la demande] (http://stackoverflow.com/questions/893474/can-i-add-javadoc-to-a-package-easily-with-eclipse/14708381#comment28966789_894385) de [Mr_and_Mrs_D] (http://stackoverflow.com/users/281545/mr-and-mrs-d), je l'ai référencé dans ma réponse ci-dessus (et upvoted le vôtre). – VonC
Dans Kepler, la case à cocher indique "Créer package-info.java". Croyez-le ou non, l'absence du trait d'union à l'étape 3 ci-dessus m'a troublé légèrement. –
Juste une note: à partir de Java 1.5, l'emplacement préféré pour le paquet commentaires est package-info.java, pas package.html. De cette façon, il est également possible de définir des annotations au niveau du package. Voir http://java.sun.com/javase/6/docs/technotes/guides/javadoc/whatsnew-1.5.0.html –