Solución:
Actualización 4 años después (octubre de 2013)
La respuesta de javabeangrinder (upvoted) menciona el siguiente truco:
Para crear un
package-info.java
archivo en un paquete existente:
- Haga clic derecho en el paquete donde desea un
package-info.java
. - Seleccione
new->package
. - Comprobar el
Create package.info.java
casilla de verificación. - Haga clic en
Finish
Respuesta original (mayo de 2009)
No hay una plantilla ni un 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 usar no solo para javadocs, sino también para anotaciones a nivel de paquete (como se ilustra aquí).
Hay un error abierto (# 86168) para exigir un asistente para la creación de package-info.java
(ya que el asistente de clases no permite package-info
nombre).
Las reflexiones sobre ese tema están en curso desde … ¡2005! El problema es que cualquier solución debe implementarse de manera que también ayude con 1.4
código.
La solución actual es crear un package-info.java
como un text
expediente.
A partir de ese momento, package-info.java
se comporta como una clase Java normal, y Eclipse coloca un package-info.class
archivo en la carpeta de salida.
los Javadocs
están construidos correctamente usando package-info.java
, y no el package.html
expediente.
(fuente: Developpez.com)
Nota (en respuesta al comentario de Strawberry):
- error 77451 (2004 !, para package.html)
- error 163633 y error 163926 (2006, para package-info.java)
ambos deseo a vista previa de la descripció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 característica.
En eclipse
Dado que package-info.java no es un identificador válido para una clase, no se puede crear como una clase en Eclipse.
Descubrí que cuando crea un nuevo paquete, hay una casilla de verificación para verificar si desea un paquete-info.java.
Para crear un archivo package-info.java en un paquete existente:
- Haga clic derecho en el paquete donde desea un package-info.java.
- Seleccione nuevo-> paquete.
- Marque la casilla de verificación Create package.info.java.
- Haga clic en Finalizar
los JAutodoc plugin hace un gran trabajo con esto, así como con todas sus otras necesidades de documentación. Instale y configure el complemento y haga clic derecho en el paquete y haga clic en JAutodoc> Agregar paquete Javadoc
Hay configuraciones y plantillas disponibles para .java
o .html
documentación del paquete.
Este complemento también hace un gran trabajo al estandarizar todas sus necesidades de Javadoc, con una gran personalización.
http://jautodoc.sourceforge.net/