¿Cómo documento paquetes en Java?
En las API de Java puedo ver comentarios de Javadoc para paquetes.
¿Cómo/dónde coloco comentarios de Javadoc para documentar un paquete?
Aceptado
A partir de la versión 1.5, puedes definir un package-info.java
archivo y proporcionar un comentario de estilo javadoc estándar para un paquete:
es/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
Especificación de idioma para paquetes
Hasta Java 1.4 inclusive, debía proporcionar un archivo HTML package.html, como se describe en las otras respuestas.
Desde Java 1.5, también puede proporcionar un archivo package-info.java
, que contiene un comentario Javadoc normal (sin HTML). Se prefiere este último, ya que le brinda algunas funciones adicionales (en particular, anotaciones de paquetes).
Detalles: documentos de Sun para javadoc