Al intentar crear comentarios Javadoc a nivel de paquete, ¿cuál es el método preferido? ¿Qué haces?
package-info.java
- Pros
- Más nuevo
- Contras
- Abuso de una clase: las clases son para código, no solo para comentarios
package.html
- Pros
- Extensión HTML significa que no es código
- Resaltado de sintaxis en IDE / editores de texto
- Contras
- ¿Ninguna?
Para mí, siempre he usado Package.html. Pero me pregunto si es la elección correcta.
package-info.java
puede contener anotaciones [paquete]: no es necesariamente todos los documentos API.package-info.java
de Javadoc y anotaciones no constituye un abuso de una clase.