web-dev-qa-db-fra.com

Javadoc: package.html ou package-info.java

Lorsque vous essayez de créer des commentaires Javadoc de niveau package, quelle est la méthode préférée? Que faire?

package-info.Java

  • Avantages
    • Plus récent
  • Les inconvénients
    • Abus d'une classe - Les classes sont pour le code, pas pour les seuls commentaires

package.html

  • Avantages
    • Extension HTML signifie que ce n'est pas du code
    • Mise en évidence de la syntaxe dans les éditeurs de texte/IDE
  • Les inconvénients
    • Aucun?

Pour moi, j'ai toujours utilisé Package.html. Mais je me demande si c'est le bon choix.

javajavadoc
223
TheLQ

package-info.Java: "Ce fichier est nouveau dans JDK 5.0 et est préféré à package.html." — javadoc - Le générateur de documentation de l'API Java

Addendum: La grande différence semble être annotations de package . Il y a un peu plus de logique dans 7.4 Déclarations de paquet .

Addendum: La fonctionnalité d'annotation est également mentionnée ici et ici .

Addendum: Voir aussi Quel est le package-info.Java pour? ].

265
trashgod