Javadoc, o "The Java API Documentation Generator," genera pagine HTML che contiene la documentazione API dai file di origine di Java. Comprendere i tag Javadoc può fare programmazione con Javadoc un processo semplificato, come la conoscenza di questi tag vi permetterà di scrivere codice in modo rapido ed efficiente. Esiste un numero di differenti tag di Javadoc, ogni specifico per un determinato aspetto del codice che consente la generazione automatica di un'API dal codice sorgente.

Passare all'elenco dei tag di Javadoc

Aprire un browser Web di vostra scelta e passare all'elenco dei tag di javadoc sul sito Web di Oracle. Nella parte superiore della pagina, si può vedere il link ai tag di Javadoc sotto la Guida di riferimento"." Selezionando questo link vi porterà ad una lista di tag di Javadoc che sono disponibili per voi da usare.

Note importanti sintassi

Capire la sintassi del tag Javadoc è importante al fine di attuarle correttamente. Javadoc tag inizia con la "@" firmare e anche sono case sensitive. È importante che seguiate queste regole di sintassi quando si lavora con i tag Javadoc. Un esempio di un tag di Javadoc per l'autore sarebbe il seguente:

@author

Si noti che il tag inizia con la "@" simbolo ed è tutto in minuscolo, come è il caso all'elenco specificato di tag Javadoc.

Tag chiave Javadoc

C'un numero di Javadoc tag che può essere utilizzato in una vasta gamma di applicazioni. Di seguito sono alcuni tag di Javadoc chiave e le loro funzioni:

@author - questo tag viene utilizzato per aggiungere una voce di autore. È possibile avere più @author tag per ogni documento e anche più nomi per il tag.

@see - questo tag viene utilizzato per creare un collegamento che è definito da un URL #value. Esempio di sintassi con questo tag è la seguente:

@see < un href="test.html > Test < /a >

Questo genera un link alla pagina di prova, visualizzato come "Test".

@version - questo tag viene utilizzato per visualizzare il numero di versione corrente del software che è in programmazione.

Differenza tra Block e Inline Tag

Un punto importante per quanto riguarda i tag Javadoc è loro posizionamento all'interno del codice. Blocco tag possono essere posizionati solo nella sezione del tag, che segue la descrizione principale. Tag inline, d'altra parte può essere posizionato ovunque nella descrizione principale e/o nei commenti per tag di blocco e sono indicati nell'elenco dei tag da parentesi graffe ({@tag}). È importante utilizzare i tag Javadoc nei posti giusti.