Uso javadoc para documentar mis clases y métodos. Me gustaría agregar algo de información general a mis paquetes, también. Me gusta cómo Eclipse crea un resguardo de un Comentario de Doc correspondiente para cada clase o método una vez que escribo /**<Enter>. ¿Eclipse también tiene una manera fácil de generar un package.html file?¿Puedo agregar JavaDoc a un paquete fácilmente con Eclipse?
Update 4 años después (octubre de 2013)
javabeangrinder 's answer (upvoted) menciona el siguiente truco:
Para crear un archivo
package-info.javaen un paquete existente:
package-info.java.new->package.Create package.info.java.FinishRespuesta original (mayo de 2009)
No hay ninguna plantilla o asistente para crear fácilmente un archivo package.html. Como dijo mmyers en su comentario, desde Java1.5, el archivo correcto para crear sería package-info.java.
Ese archivo se puede utilizar no solo para javadocs, sino también para package-level annotations (como illustrated here).
Hay un opened Bug (#86168) por exigir un asistente para la creación de package-info.java (ya el asistente de clase no permite el nombrepackage-info).
Las reflexiones sobre ese tema están encendidas desde ... 2005! El problema es que cualquier solución debe implementarse de una manera que también ayude con el código 1.4.
La solución actual es crear un package-info.java como un archivo text.
A partir de ese momento, package-info.java se comporta como una clase normal de Java y Eclipse coloca un archivo package-info.class en la carpeta de salida.
Javadocs están construidos correctamente utilizando package-info.java, y no el archivo package.html.
alt text http://jmdoudoux.developpez.com/cours/developpons/java/images/jaxb006.png
Nota (en respuesta a Strawberry 's comentario):
tanto deseo una vista previa de la visión general del paquete en package-info.java en la vista Javadoc .
Hasta ahora, no se ha propuesto/implementado ningún parche.
Simplemente no hay suficientes demandas para que se agregue esa función.
¿Hay alguna forma de que el paquete javadocs se muestre en la ventana de vista rápida de Javadoc? hacer para las clases, interfaces y métodos? – Martin
@Strawberry: no, no hay vista de Javadoc para package-info.java. Ver mi respuesta extendida sobre eso. – VonC
Nota para mí, después de [esta pregunta] (http://stackoverflow.com/a/9600531/6309), tengo que cruzar más de 200K * otra vez *! (debido a algunos [rep recalc] (http://meta.stackexchange.com/questions/125121/has-reputation-for-deleted-posts-been-removed-again)) – VonC
Hay un complemento que parece crear archivos package.html. No lo he usado, pero alguien que aterrice aquí podría encontrarlo útil.
El JAutodoc plug-in hace un gran trabajo de este, así como todas sus otras necesidades de documentación. Instalar y configurar el plugin y haga clic derecho en el paquete y haga clic en JAutodoc> Agregar paquete Javadoc
Hay configuraciones y plantillas disponibles para la documentación .java o .html paquete.
Este complemento también hace un gran trabajo al estandarizar todas sus necesidades de Javadoc, con una gran personalización.
en Eclipse
Desde package-info.java no es un identificador válido para una clase que no se puede crear como una clase en Eclipse.
Encontré que cuando creas un nuevo paquete hay una casilla de verificación para verificar si deseas un paquete-info.java.
Para crear un archivo package-info.java en un paquete existente:
Jaja, eso es tan intuitivo, gracias :) No responde la pregunta, ¡pero me ayudó! –
+1. [A petición] (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), lo he mencionado en mi respuesta anterior (y he subido la suya). – VonC
En Kepler, la casilla ahora dice "Crear paquete-info.java". Créalo o no, la falta del guión en el paso 3 anterior me confundió un poco. –
Sólo una nota: a partir de Java 1.5, la ubicación preferida para el paquete de comentarios es package-info.java, no package.html. De esta forma, también es posible definir anotaciones a nivel de paquete. Ver http://java.sun.com/javase/6/docs/technotes/guides/javadoc/whatsnew-1.5.0.html –