llama - ¿Cómo agregar comentarios a nivel de paquete en Javadoc?

javadoc pdf

Question

Esta pregunta ya tiene una respuesta aquí:

• ¿Cómo documento los paquetes en Java? 3 respuestas

Estoy usando Check-Style, FindBugs y PMD para validar mi código de Java. He solucionado casi todos los errores capturados por estas herramientas.

No puedo entender cómo escribir el "comentario del paquete", que es un error atrapado por el estilo de control. He revisado la documentación de Check-Style, pero no lo entiendo.

¿Podría alguien ayudarme a escribir un comentario a nivel de paquete en Java?

Answer 1

1. Cree un archivo package-info.java en su paquete para documentar
2. Agregue el descriptor del paquete
3. Agregue un comentario (/ ** ... * /) antes de la declaración del paquete

El siguiente enlace proporciona más información: http://docs.oracle.com/javase/specs/jls/se5.0/html/packages.html

Se recomienda que package-info.java, si está presente, tome el lugar de package.html para javadoc y otros sistemas de generación de documentación similares.

Las anotaciones amplias del paquete también se declararán en package-info.java

Greetz, GHad

Answer 2

Al usar un archivo package.html para sus comentarios. Consulte este documento: Cómo escribir comentarios de documentos para la herramienta Javadoc .

Answer 3

Debes crear una página package.html ubicada dentro del paquete. Puede leer sobre los contenidos y la estructura de este archivo en Cómo escribir comentarios del documento para la página de la herramienta Javadoc .

Answer 4

Google encontró esto como el primer golpe:

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#packagecomments

Usted acaba de crear un archivo llamado package.html en cada paquete.

Answer 5

Hay dos formas de agregar documentación a nivel de paquete usando javadoc:

1. package-info.java
   • Solo desde 5.0
   • Manera preferida
   • Puede contener una declaración de paquete, anotaciones de paquete, comentarios de paquete y etiquetas Javadoc
2. package.html
   • Cualquier versión de Java
   • No puede contener declaración de paquete y / o anotaciones de paquete

Más detalles y ejemplos están here . Cuál usar: Javadoc: package.html o package-info.java

Answer 6

Puede agregar documentación a nivel de paquete.

De la java.sun.com/docs/books/jls/third_edition/html/packages.html :

Normalmente package-info.java contiene solo una declaración de paquete, precedida inmediatamente por las anotaciones en el paquete. Si bien el archivo podría contener técnicamente el código fuente de una o más clases privadas del paquete, sería muy malo.

Se recomienda que package-info.java, si está presente, tome el lugar de package.html para javadoc y otros sistemas de generación de documentación similares. Si este archivo está presente, la herramienta de generación de documentación debe buscar el comentario de la documentación del paquete inmediatamente anterior a la declaración del paquete (posiblemente anotada) en package-info.java. De esta forma, package-info.java se convierte en el único repositorio de anotaciones y documentación a nivel de paquete. Si, en el futuro, resulta conveniente agregar cualquier otra información a nivel de paquete, este archivo debería ser un hogar conveniente para esta información.

Answer 7

Los comentarios de javadoc a nivel de paquete se colocan en un archivo llamado package-info.java dentro del directorio del paquete. Contiene el comentario y una declaración del paquete:

/**
* Provides the classes necessary to create an applet and the classes an applet uses
* to communicate with its applet context.
* <p>
* The applet framework involves two entities:
* the applet and the applet context. An applet is an embeddable window (see the
* {@link java.awt.Panel} class) with a few extra methods that the applet context
* can use to initialize, start, and stop the applet.
*
* @since 1.0
* @see java.awt
*/
package java.lang.applet;

Esto está documentado aquí: Archivos de comentarios del paquete