reutilizacion - que son los paquetes java
¿Cómo documento los paquetes en Java? (3)
En las API de Java puedo ver comentarios de Javadoc para paquetes.
¿Cómo / dónde coloco los comentarios de Javadoc para documentar un paquete?
Con un archivo package.html a nivel de paquete (es decir, en el directorio de ese paquete). Debería ser un archivo HTML completamente formado, con la etiqueta <html> definida en él
Hasta Java 1.4, 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 Javadoc (sin HTML). Este último es preferido, ya que le da algunas características adicionales (notablemente anotaciones de paquetes).
Detalles: documentos de Sun para javadoc
A partir de 1.5, puede definir un archivo package-info.java 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