Réponses:
À partir de la version 1.5, vous pouvez définir un package-info.java
fichier et fournir un commentaire de style javadoc standard pour un package:
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'à et y compris Java 1.4, 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 régulier (pas de HTML). Ce dernier est préféré, car il vous donne des fonctionnalités supplémentaires (notamment les annotations de package).
Détails: documentation de Sun pour javadoc
package-info.java
très bien.
Avec un package.html
fichier au niveau du package (c'est-à-dire dans le répertoire de ce package). Il doit s'agir d'un HTML
fichier entièrement formé , avec la <html>
balise définie