Risposte:
A partire da 1.5 è possibile definire un package-info.java
file e fornire un commento standard in stile javadoc per un pacchetto:
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
Fino a Java 1.4 incluso, è stato necessario fornire un file HTML package.html, come descritto nelle altre risposte.
Da Java 1.5 puoi anche fornire un package-info.java
, che contiene un normale commento Javadoc (senza HTML). Quest'ultimo è preferito, in quanto offre alcune funzionalità extra (in particolare le annotazioni del pacchetto).
Dettagli: i documenti di Sun per javadoc
package-info.java
bene.
Con un package.html
file a livello di pacchetto (cioè nella directory per quel pacchetto). Questo dovrebbe essere un HTML
file completo , con il <html>
tag definito in esso