151
Nelle API Java posso vedere i commenti Javadoc per i pacchetti.Come posso documentare i pacchetti in Java?
Come/dove inserire i commenti Javadoc per documentare un pacchetto?
A
risposta
214
Come di 1,5 è possibile definire un file package-info.java e fornire un commento stile javadoc standard 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
3
Con un file a livello di pacchetto (ad esempio nella directory per quel pacchetto). Questo dovrebbe essere un file HTML completo, con il tag <html> definito in esso
38
Fino a Java 1.4, era necessario fornire un file HTML package.html, come descritto nelle altre risposte.
Poiché Java 1.5 è anche possibile fornire un package-info.java, che contiene un commento Javadoc regolare (senza HTML). Quest'ultimo è preferito, in quanto offre alcune funzionalità extra (in particolare le annotazioni del pacchetto).
Dettagli: Sun's docs for javadoc
+2
+1 per menzionare entrambi i modi e la differenza essenziale tra di essi. A proposito, almeno IntelliJ IDEA ha attualmente un miglior supporto per package.html (Ctrl-Q su un nome di pacchetto mostra il pacchetto Javadocs). – Jonik
+1
Aggiornamento al mio commento precedente: oggigiorno IDEA supporta 'package-info.java' bene. – Jonik
Link diretto alle specifiche: http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 – gavenkoa
in intellij è possibile fare clic destro su un pacchetto e l'opzione per creare questo dovrebbe essere sotto il nuovo menu file – bsautner