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
Problemi correlati
- 1. Come compilare i pacchetti in java?
- 2. Come posso documentare correttamente i membri dell'istanza aggiunti tramite Object.defineProperties?
- 3. Come posso documentare i set di dati con roxygen?
- 4. Come documentare il mio metodo in Java come i documenti Java?
- 5. Posso definire i pacchetti opzionali in setuptools?
- 6. Come documentare i callback usando JSDoc?
- 7. In elisir, Come posso installare i pacchetti a livello globale?
- 8. Come documentare i parametri POST con Apiary?
- 9. Condivisione di pacchetti Java tra i moduli in IntelliJ?
- 10. Quali strumenti posso usare per documentare i testicoli?
- 11. Come documentare un metodo con i parametri?
- 12. Mappatura tra pacchetti Oracle e pacchetti Java
- 13. Come annusare i pacchetti HTTP in python?
- 14. Pacchetti e classi Java
- 15. Importazione di pacchetti in Java
- 16. Come posso documentare un doppio array di stringhe in JSDoc?
- 17. Come posso documentare un tipo in webstorm usando solo jsdoc?
- 18. come posso confrontare i colori in java?
- 19. Come importare i pacchetti locali in go?
- 20. Come posso dire a Bower dove installare i pacchetti?
- 21. Come documentare un database
- 22. Come funzionano i pacchetti in golang
- 23. Come posso acquisire i pacchetti di rete per PID?
- 24. Come posso ricostruire i pacchetti Golang nativi dopo averli modificati?
- 25. Come posso documentare in modo conciso i metodi nel codice Perl?
- 26. Come elencare i pacchetti installati in Cabal?
- 27. Come utilizzare i pacchetti in Julia Studio
- 28. Come trovare i pacchetti duplicati in npm?
- 29. Come documentare un dizionario in JSDoc?
- 30. Come utilizzare i pacchetti "interni"?
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