[JAVA] chiarimenti su "javadoc"

[gordian]

Ciao a tutti,
ho letto su un manuale che attraverso il "javadoc" (che è parte integrante dell'installazione del JDK) è possibile generare un file HTML che visualizza i commenti inseriti in un file java.

Mi riporta un esempio del genere:

/** commento classe */
public class docTest {
 /** commento variabile */
 public int i;
 /** commento metodo */
 public void f() {}
}

e mi dice di esaminare questo file con javadoc per vedere il risultato nella pag. HTML..

Ma come si fa esattamente?
Grazie.

[anx721]

Da dos portati nella cartella che contiene il tuo file.java e digita:

javadoc -private -d cartellaDestinazione NomeClasse

in questo modo sarà generata la documentazione all'inerno di cartellaDestinazione relativa alla classe NomeClasse; puoi anche mettere piu nomi di classi di seguito o nomi di package; il file principale della documentazione dovrebbe essere index.html,

[gordian]

Originariamente inviato da anx721
Da dos portati nella cartella che contiene il tuo file.java e digita:

javadoc -private -d cartellaDestinazione NomeClasse

in questo modo sarà generata la documentazione all'inerno di cartellaDestinazione relativa alla classe NomeClasse; puoi anche mettere piu nomi di classi di seguito o nomi di package; il file principale della documentazione dovrebbe essere index.html,

Ho cercato di fare come hai detto ma qualcosa dev'essere andato storto.
- Ho creato un file (con textpad) chiamato docTest.java
- Ho eseguito la compilazione (sempre con textpad) per creare la classe docTest.class
- Dal prompt di DOS sono poi andato nella cartella che li conteneva e ho quindi scritto:
javadoc -private -d cartella docTest.class

DOS mi ha restituito questo:

Loading source files for package docTest...
javadoc: warning - No source files for package docTest
Constructing Javadoc information...
javadoc: warning - No source files for package docTest
No public or protected classes found to document.
2 warnings

Cosa posso aver sbagliato? Nessun fie HTML è stato generato.

Comunque non capisco veramente come mai il manuale mi chieda di eseguire certi comandi senza neanche specificare come si faccia... :master:

[Zero-2]

Beh se non vuoi eseguirli manualmente puoi usare editor come Eclipse , che li effettuano in automatico

CIauz

[gordian]

Originariamente inviato da Zero-2
Beh se non vuoi eseguirli manualmente puoi usare editor come Eclipse , che li effettuano in automatico

CIauz

Scusa ma non ho capito cosa intendi. Sono alle primissime armi con JAVA.
Io ho installato come editor TEXTPAD che nel menu strumenti permette di eseguire i file .java. Non so se Eclipse fa qualcosa in +.
In questo momento stavo solo cercando di visualizzare i commenti in un file HTML per mezzo di JAVADOC.

Per "eseguire" intendevi quello? :master:
Ho le idee molto confuse cavolo...

[netarrow]

Originariamente inviato da gordian
Scusa ma non ho capito cosa intendi. Sono alle primissime armi con JAVA.
Io ho installato come editor TEXTPAD che nel menu strumenti permette di eseguire i file .java. Non so se Eclipse fa qualcosa in +.
In questo momento stavo solo cercando di visualizzare i commenti in un file HTML per mezzo di JAVADOC.

Per "eseguire" intendevi quello? :master:
Ho le idee molto confuse cavolo...

il mio libro dice di passare a javadoc il file sorgente, non la classe compilata. Cmq, sempre dal mio libro, viene affermato che javadoc è implementato diversamente a seconda dell'ambiente in uso e della versione. Quindi dovresti vedere il tuo che comandi possiede.

Con il comando
javadoc > option.txt
Nel file option.txt troverai tutte le opzioni che servono al programma, o che sono facoltative. Attento ad aprirlo con word pad che con blocco note sul mio non ci sono gli a capi.

Zero-2 intendeva che su eclipse c'è un wizard che esporta la documentazione del progetto. E cmq eclipse fa molto di +

[anx721]

Si, la sintassi che avevo data io va bene si si passa il nome di un package; se non hai definito un package passa il nome del file:

javadoc -d doc -private nomeFile.java

per creare la documentazione nella cartella doc,

[gordian]

Originariamente inviato da anx721
Si, la sintassi che avevo data io va bene si si passa il nome di un package; se non hai definito un package passa il nome del file:

javadoc -d doc -private nomeFile.java

per creare la documentazione nella cartella doc,

Continua a darmi gli stessi errori. Non vorrei sbagliare qualcosa da DOS.
Allora: il mio file si chiama DocTest.java ed è nella cartella D:\cartella
Dal prompt scrivo esattamente questo:
cd D:\cartella
....invio e poi digito:
javadoc -d cartella -private DocTest.java

Ho provato anche a scrivere come avevi postato prima:
javadoc -private -d cartella DocTest.java
ma niente da fare

[anx721]

sicuro che riesci a portarti all'interno della cartella?
se no devi fare:

d:

e poi cd nomecartella

[gordian]

Originariamente inviato da anx721
sicuro che riesci a portarti all'interno della cartella?
se no devi fare:

d:

e poi cd nomecartella

Grazie 1000!
Era quello l'errore.