Javadoc : package.html ou paquet-info.java

Question

Lorsque vous essayez de créer ensemble des commentaires Javadoc, ce qui est la méthode préférée? Que faites-vous?

package-info.java

• Pros
  • Plus récente
• Cons
  • L'abus d'une classe - Classes sont pour le code, pas seulement pour les commentaires

package.html

• Pros
  • L'extension HTML sans code
  • La coloration syntaxique dans l'IDE/éditeurs de texte
• Cons
  • Aucun?

---

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

Answer 1

package-info.java: "Ce fichier est nouveau dans le JDK 5.0, et de préférence plus de package.html."-javadoc - L'API Java Générateur de Documentation

Addendum: La grande différence semble être forfait annotations. Il y a un peu plus dans la voie de la raison d'être de 7.4 Paquet Déclarations.

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

Addendum: Voir aussi la Programmation Déclarative en Java: le Paquet au Niveau des Annotations.