Comment documenter des packages en Java?
Dans les API Java, je peux voir les commentaires Javadoc des packages.
Comment/où puis-je placer des commentaires Javadoc pour documenter un paquet?
À partir de 1.5, vous pouvez définir un package-info.Java file et fournit un commentaire de style javadoc standard pour un paquet:
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
Jusqu'à Java 1.4 inclus, vous deviez fournir un fichier HTML package.html, comme décrit dans les autres réponses.
Depuis Java 1.5, vous pouvez également fournir un package-info.Java, Qui contient un commentaire Javadoc normal (pas de HTML). Ce dernier est préférable, car il vous donne quelques fonctionnalités supplémentaires (notamment les annotations de package).
Détails: documentation de Sun pour javadoc
Avec un package.html fichier au niveau du paquet (c'est-à-dire dans le répertoire de ce paquet). Cela devrait être un fichier HTML entièrement formé, avec le fichier <html> balise définie dans celle-ci