Respuestas:
A partir de 1.5, puede definir un package-info.java
archivo y proporcionar un comentario de estilo javadoc estándar para un paquete:
com / foo / package-info.java:
/**
* com.foo is a group of bar utils for operating on foo things.
*/
package com.foo;
//rest of the file is empty
Hasta Java 1.4 incluido, tenía que proporcionar un archivo HTML package.html, como se describe en las otras respuestas.
Desde Java 1.5 también puede proporcionar un package-info.java
, que contiene un comentario regular de Javadoc (sin HTML). Se prefiere este último, ya que le brinda algunas características adicionales (especialmente las anotaciones del paquete).
Detalles: documentos de Sun para javadoc
package-info.java
.
Con un package.html
archivo a nivel de paquete (es decir, en el directorio de ese paquete). Este debe ser un HTML
archivo completamente formado , con la <html>
etiqueta definida en él