usar - javadoc pdf

Javadoc: package.html o package-info.java

Question

Cuando se trata de 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 los editores de IDE / texto
• Contras
  • ¿Ninguna?

Para mí, siempre he usado Package.html. Pero me pregunto si es la elección correcta.

Answer 1

package-info.java : "Este archivo es nuevo en JDK 5.0, y se prefiere a package.html." - javadoc - El generador de documentación de API de Java

Anexo: La gran diferencia parece ser las anotaciones de paquetes . Hay un poco más en cuanto a la justificación en 7.4 Declaraciones de paquetes .

Anexo: La característica de anotación también se menciona here y here .

Anexo: Consulte también ¿ Para qué se incluye package-info.java ? .