151
Dans les API Java, je peux voir les commentaires Javadoc pour les paquets.Comment puis-je documenter des paquetages en Java?
Comment/comment placer des commentaires Javadoc pour documenter un paquet?
A
Répondre
214
Au 1.5, vous pouvez définir un fichier package-info.java et fournir un commentaire de style standard javadoc pour un forfait:
com/foo/package-info.java:
/**
* com.foo is a group of bar utils for operating on foo things.
*/
package com.foo;
//rest of the file is empty
3
Avec un fichier package.html au niveau du package (c'est-à-dire dans le répertoire de ce package). Il doit s'agir d'un fichier HTML complet, avec la balise <html> définie.
38
Jusqu'à Java 1.4, vous deviez fournir un fichier HTML package.html, comme indiqué dans les autres réponses.
Depuis Java 1.5, vous pouvez également fournir un package-info.java, qui contient un commentaire Javadoc standard (pas de code HTML). Ce dernier est préféré, car il vous donne des fonctionnalités supplémentaires (notamment des annotations de paquets).
Détails: Sun's docs for javadoc
+2
+1 pour mentionner les deux manières, et la différence essentielle entre elles. En passant, au moins IntelliJ IDEA a actuellement un meilleur support pour package.html (Ctrl-Q sur un nom de paquet montre le paquet Javadocs). – Jonik
+1
Mise à jour de mon commentaire précédent: de nos jours, IDEA supporte 'package-info.java'. – Jonik
Lien direct vers spec: http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 – gavenkoa
dans intellij vous pouvez faire un clic droit sur un paquet et l'option pour créer cela devrait être dans le nouveau menu de fichiers – bsautner