Come documentare i pacchetti in Java?


182

Nelle API Java posso vedere i commenti Javadoc per i pacchetti.

Come / dove inserisco i commenti Javadoc per documentare un pacchetto?

Risposte:


257

A partire da 1.5 è possibile definire un package-info.javafile 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

Specifica del linguaggio per i pacchetti



7
in intellij puoi fare clic con il tasto destro del mouse su un pacchetto e l'opzione per crearlo dovrebbe essere nel menu Nuovo file
bsautner

Ho trovato che il file doveva essere in nomepacchetto / src / nomepacchetto (con il resto dei file di origine)
trindflo

48

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


2
+1 per menzionare entrambi i modi e la differenza essenziale tra loro. A proposito, almeno IntelliJ IDEA ha attualmente un supporto migliore per package.html (Ctrl-Q sul nome di un pacchetto mostra il pacchetto Javadocs).
Jonik,

3
Aggiornamento al mio commento precedente: oggi IDEA supporta package-info.javabene.
Jonik,

4

Con un package.htmlfile a livello di pacchetto (cioè nella directory per quel pacchetto). Questo dovrebbe essere un HTMLfile completo , con il <html>tag definito in esso


1
Più dettagli? Come dovrebbe essere il file?
jjnguy,

1
È un file HTML che contiene la descrizione del tuo pacchetto. Questo è tutto!
oxbow_lakes

3
Questo è il vecchio modo di farlo. Da Java 1.5 in poi puoi usare
package-info.java
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.