¿Cómo documento paquetes en Java?

Resuelto jjnguy asked hace 15 años • 3 respuestas

En las API de Java puedo ver comentarios de Javadoc para paquetes.

¿Cómo/dónde coloco comentarios de Javadoc para documentar un paquete?

jjnguy avatar Mar 09 '09 05:03 jjnguy
Aceptado

A partir de la versión 1.5, puedes definir un package-info.javaarchivo 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

Gareth Davis avatar Mar 08 '2009 22:03 Gareth Davis

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

sleske avatar Mar 08 '2009 22:03 sleske