Lorsque vous essayez de créer des commentaires Javadoc au niveau du 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 seulement pour les commentaires
package.html
- Avantages
- L'extension HTML signifie que ce n'est pas du code
- Mise en évidence de la syntaxe dans les éditeurs IDE / texte
- Les inconvénients
- Aucun?
Pour moi, j'ai toujours utilisé Package.html. Mais je me demande si c'est le bon choix.
package-info.java
pour Javadoc et Annotations n'est pas un abus de classe.
package-info.java
peut contenir des annotations [package] - ce n'est pas nécessairement tous les documents API.