Uso javadoc per documentare le mie classi e metodi. Vorrei aggiungere anche alcune informazioni di panoramica ai miei pacchetti. Mi piace come Eclipse crea uno stub di un commento Doc corrispondente per ogni classe o metodo una volta digitato lo /**<Enter>. Eclipse ha un modo semplice per generare anche uno package.html file?Posso aggiungere JavaDoc a un pacchetto facilmente con Eclipse?
Update 4 anni dopo (ottobre 2013)
javabeangrinder s' answer (upvoted) menziona il seguente trucco:
Per creare un file
package-info.javain un pacchetto esistente:
package-info.java.new->package.Create package.info.java.Finishrisposta Originale (maggio 2009)
Non v'è alcun modello o una procedura guidata per creare facilmente un file package.html.
Come mmyers ha detto nel suo commento, dal Java1.5, il file corretto da creare sarebbe package-info.java.
Questo file può essere utilizzato non solo per javadocs, ma anche per package-level annotations (come illustrated here).
C'è un opened Bug (#86168) per i più esigenti una procedura guidata per la creazione di package-info.java (dal la procedura guidata di classe non permette il package-info nome).
Le riflessioni su questo argomento sono attive dal ... 2005! Il problema è che qualsiasi soluzione dovrebbe essere implementata in modo da aiutare anche con il codice 1.4.
La soluzione corrente consiste nel creare un file package-info.java come file text.
Da questo punto in avanti, package-info.java si comporta come una normale classe Java ed Eclipse inserisce un file package-info.class nella cartella di output.
Gli Javadocs sono costruiti correttamente utilizzando package-info.java e non il file .
alt text http://jmdoudoux.developpez.com/cours/developpons/java/images/jaxb006.png
Nota (in risposta a Strawberry 's commento):
sia desiderio un'anteprima della panoramica pacchetto package-info.java nel Javadoc vista.
Finora, nessuna patch è stata proposta/implementata.
Semplicemente non c'è abbastanza richiesta per quella funzionalità da aggiungere.
Esiste comunque la possibilità di visualizzare il pacchetto javadoc nella finestra di visualizzazione rapida di Javadoc, poiché fare per classi, interfacce e metodi? – Martin
@Strawberry: no, nessuna vista Javadoc per package-info.java. Vedi la mia risposta estesa su questo. – VonC
Nota per se stessi, dopo [questa domanda] (http://stackoverflow.com/a/9600531/6309), ho avuto modo di incrociare nuovamente 200K * *! (a causa di alcuni [rip ricalcolo] (http://meta.stackexchange.com/questions/125121/has-reputation-for-deleted-posts-been-removed-again)) – VonC
C'è un plugin che sembra creare file package.html. Non l'ho usato ma qualcuno che atterra qui potrebbe trovarlo utile.
Il JAutodoc plug-in fa un grande lavoro di questo, così come tutte le altre esigenze di documentazione. Installare e configurare il plugin e fare clic destro del pacchetto e scegliere JAutodoc> Aggiungi pacchetto Javadoc
ci sono configurazioni e modelli disponibili per la documentazione .java o .html pacchetto.
Questo plugin fa anche un ottimo lavoro di standardizzazione di tutte le vostre esigenze Javadoc, con una grande quantità di personalizzazione.
in Eclipse
Dato package-info.java non è un identificatore valido per una classe non può essere creato come una classe in Eclipse.
Ho scoperto che quando si crea un nuovo pacchetto è presente una casella di controllo per verificare se si desidera un pacchetto-info.java.
Per creare un file package-info.java in un pacchetto esistente:
Haha è così intuitivo, grazie :) Non risponde alla domanda, ma mi ha aiutato! –
+1. [Alla richiesta] (http://stackoverflow.com/questions/893474/can-i-add-javadoc-to-a-package-easily-with-eclipse/14708381#comment28966789_894385) di [Mr_and_Mrs_D] (http://stackoverflow.com/users/281545/mr-and-mrs-d), l'ho fatto riferimento nella mia risposta sopra (e ha rialzato il tuo). – VonC
In Kepler la casella di controllo ora dice "Crea pacchetto-info.java". Che ci crediate o no, la mancanza del trattino nel punto 3 sopra mi ha leggermente confuso. –
Solo una nota: come di Java 1.5, la posizione preferita per il pacchetto di osservazioni è package-info.java, non package.html. In questo modo, è anche possibile definire annotazioni a livello di pacchetto. Vedere http://java.sun.com/javase/6/docs/technotes/guides/javadoc/whatsnew-1.5.0.html –