Javadoc: paquete.html o paquete-info.java

Resuelto TheLQ asked hace 14 años • 1 respuestas

Al intentar crear comentarios Javadoc a nivel de paquete, ¿cuál es el método preferido? ¿A qué te dedicas?

paquete-info.java

  • Ventajas
    • Más nuevo
  • Contras
    • Abuso de una clase: las clases son para código, no solo para comentarios

paquete.html

  • Ventajas
    • La extensión HTML significa que no es código
    • Resaltado de sintaxis en IDE/editores de texto
  • Contras
    • ¿Ninguno?

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

TheLQ avatar Sep 05 '10 09:09 TheLQ
Aceptado

package-info.java: "Este archivo es nuevo en JDK 5.0 y se prefiere a package.html."— javadoc - The Java API Documentation Generator

Anexo: La gran diferencia parece ser las anotaciones del paquete . Hay un poco más de fundamento en 7.4 Declaraciones de paquetes .

Anexo: La función de anotación también se menciona aquí y en el consejo de Javadoc: Prefiera package-info a package.html , citado aquí .

Anexo: Véase también ¿ Para qué package-info.javasirve? .

trashgod avatar Sep 05 '2010 02:09 trashgod