Come creare Javadoc nel commentare

Javadoc è lo standard de facto per la generazione di documentazione a partire dal codice sorgente . E ' uno strumento per creare documentazione HTML da commenti in formato speciale in codice Java . Questo può essere usato per generare la documentazione interfaccia di programmazione strutturata ( API ) in modo automatico , dare alcuni suggerimenti per l'IDE o per l'attribuzione di pacchetti , classi e metodi. In sostanza , si tratta di un modo di commentare descrizioni dei parametri , che ha scritto che cosa , e chi la colpa se si rompe . Java viene fornito con il programma da riga di comando javadoc per generare la documentazione in formato HTML , ma ambienti di sviluppo integrati (IDE Java più ) hanno anche questo integrato . Istruzioni
1

Creare speciali commenti Javadoc . Per denotare un commento javadoc , iniziare il commento con /** . Commenti Javadoc esistono normalmente nella parte superiore di un file , prima classi prima e metodi. Dal momento che è stato progettato per la documentazione API completa , non è raro vedere i file con più commenti javadoc di codice . "" /*** Questo è un commento javadoc . Non ha alcun javadoc meta- tag per adesso , ma lo ha fatto scattare il parser javadoc di dare un'occhiata a questo commento . * /" "
2

Aggiungi API meta- tag ( tag che descrivono la stessa API ) quando si commenta . Tags API sono i nomi dei parametri , descrizioni , profili di eccezione , le descrizioni del valore di ritorno , i nomi e le descrizioni dei metodi di metodo. Molti IDE incorporano questi dati nelle loro estremità attrezzi e altri soccorritori , come pure che sia per l'uso in forma di commento HTML o .
3

Utilizzare la descrizione del metodo. Questa meta- tag non ha un nome di tag : E 'semplicemente il commento che arriva prima degli altri tag " " /*** Calcola la pendenza di una retta . . * /" "
4

Incorporare descrizioni dei parametri . Questi sono indicati con il param @ meta-tag , che dovrebbe essere seguito da un nome del parametro e descrizione " . " /*** Calcola la pendenza di una retta . ** @ Param P1 Primo punto che descrive la linea * @ param P2 Secondo punto che descrive la linea * /"
5

descrizioni " ritorno di valore . Questa è segnato con il ritorno @ meta- tag e dovrebbe essere seguita da una descrizione del valore di ritorno " . " /*** Calcola la pendenza di una retta . ** @ Param P1 Primo punto che descrive la linea * @ param P2 Secondo punto che descrive la linea * @ return Pendenza della linea come un float * /" "
6

Aggiungi tag attribuzione . I tag attribuiscono il codice di un autore specifico . "" /*** Calcola la pendenza di una retta . ** @ Autore Jack Smith * @ param P1 Primo punto che descrive la linea * @ param P2 Secondo punto che descrive la linea * @ return Pendenza della linea come un float * /" "
7

generare la documentazione HTML . Se non stai usando un IDE o volete semplicemente di farlo manualmente , è possibile eseguire il programma da riga di comando javadoc dalla cartella del progetto . Specificare la directory di output con il d -switch e passare un elenco di file . Java (di solito come un jolly ) . " " Javadoc - d docs * . Java " "

• Come installare Java 
• Come lasciare commenti nel codice Java