Java Language Documentación del paquete


Ejemplo

Java SE 5

Es posible crear documentación a nivel de paquete en Javadocs usando un archivo llamado package-info.java . Este archivo se debe formatear como se muestra a continuación. Los espacios en blanco iniciales y los asteriscos son opcionales, normalmente están presentes en cada línea por razones de formato

/**
 * Package documentation goes here; any documentation before the first period will 
 * be used as a summary.
 *
 * It is common practice to leave a blank line between the summary and the rest
 * of the documentation; use this space to describe the package in as much detail
 * as is appropriate.
 * 
 * Inline tags such as {@code code here}, {@link reference.to.other.Documentation},
 * and {@literal text here} can be used in this documentation.
 */
package com.example.foo;

// The rest of the file must be empty.

En el caso anterior, debe colocar este archivo package-info.java dentro de la carpeta del paquete de Java com.example.foo .