Javadoc: package.html ou package-info.Java

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

Forfait-info.java

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

Paquet.html

  • Avantages
    • L'extension HTML signifie que son code n'est pas
    • Coloration syntaxique dans text's / text éditeurs
  • Inconvénients
    • Aucun?

Pour moi, j'ai toujours utilisé Package.HTML. Mais je me demandais si ses le bon choix.

Author: Robert, 2010-09-05
Source

1 answers

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 paquet . Il y a un peu plus de logique dans 7.4 Déclarations de Paquet.

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

Addendum: Voir aussi Programmation Déclarative dans Java: Annotations au niveau du paquet.

 257
Author: trashgod, 2016-11-25 13:16:44