151
En las API de Java puedo ver comentarios de Javadoc para paquetes.¿Cómo puedo documentar paquetes en Java?
¿Cómo/dónde coloco los comentarios de Javadoc para documentar un paquete?
A
Respuesta
214
A partir de 1,5 se puede definir un archivo package-info.java y proporcionar un estilo de comentarios 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
3
Con un archivo package.html en el nivel del paquete (es decir, en el directorio de ese paquete). Debería ser un archivo HTML totalmente formado, con la etiqueta <html> definida en él
38
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 de Javadoc (sin HTML). Este último es preferido, ya que le da algunas características adicionales (notablemente anotaciones de paquetes).
Detalles: Sun's docs for javadoc
+2
+1 para mencionar las dos formas y la diferencia esencial entre ellas. Por cierto, al menos IntelliJ IDEA actualmente tiene mejor soporte para package.html (Ctrl-Q en un nombre de paquete muestra el paquete Javadocs). – Jonik
+1
Actualiza a mi comentario anterior: hoy en día, IDEA admite 'package-info.java' muy bien. – Jonik
Cuestiones relacionadas
- 1. Documentar paquetes de Python con doxygen
- 2. ¿Cómo compilar paquetes en Java?
- 3. ¿Cómo documentar mi método en Java como documentos Java?
- 4. ¿Cómo puedo documentar un C# dll
- 5. cómo documentar un paquete python
- 6. Cómo usar paquetes de terceros en Java
- 7. Importación de paquetes en Java
- 8. ¿Cómo puedo documentar los métodos concisamente en el código Perl?
- 9. Cómo puedo documentar tablas y campos en SQL Server 2005
- 10. Asignación entre paquetes Oracle y paquetes Java
- 11. paquetes estadísticos de Java
- 12. ¿Compartir paquetes Java entre módulos en IntelliJ?
- 13. ¿Cómo puedo documentar conjuntos de datos con roxygen?
- 14. ¿cómo puedo documentar una clase de referencia R?
- 15. Para Java, ¿puedo importar todos los paquetes a la vez?
- 16. Cómo documentar la devolución en JavaScript
- 17. Agregar paquetes Java a GWT
- 18. Cómo documentar un archivo MAKE?
- 19. Cómo documentar getters y setters
- 20. Cómo documentar campos y propiedades en Python?
- 21. cómo documentar constructores generados en doxygen
- 22. Java: acceso protegido en los paquetes
- 23. ¿Cómo nombrar los paquetes de importación/exportación en Java?
- 24. ¿Puedo definir paquetes opcionales en setuptools?
- 25. ¿Cómo puedo compartir valores globales entre diferentes paquetes en Perl?
- 26. ¿Cómo puedo encontrar los paquetes definidos en un contenedor?
- 27. ¿Puedo usar DoxyGen para documentar el código de ActionScript?
- 28. ¿Cómo documentar un tipo de pato?
- 29. Cómo documentar una base de datos
- 30. ¿Cómo usar comentarios en línea para documentar miembros en .NET?
Enlace directo a la especificación: http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 – gavenkoa
en intellij puede hacer clic derecho en un paquete y la opción para crear esto debe estar bajo el nuevo menú de archivo – bsautner