Question

Cos'è Javadoc e quali sono i tag fondamentali?

Answer 1

javadoc è uno strumento che permette di generare la documentazione di un programma attraverso l'inserimento di tag specifici  nel codice stesso,la documentazione in  javadoc produce un insieme di pagine HTML . 

ecco alcuni dei tag più usati:

IMPORTANTE: i nomi dei tag vanno preceduti dal simbolo '@' e vanno sempre scritti prima del metodo/classe interessata.

• @author   (permette di visualizzare il nome dell'autore della classe)
• @versione   (permette di visualizzare la versione della classe)
• @param nomeprarametro   (descrizione del parametro di un metodo)
• @return   (descrive il valore di ritorno di un metodo)
• @exception o @throws (descrive un eccezione presente nel metodo)
• @see   (permette l'inserimento di un riferimento) 

 

Answer 2

Javadoc è un meccanismo che permette di creare vari file di documentazione basati su HTML. Esso viene adoperato per fornire una documentazione sul codice implementato.

In Java, il programmatore per descrivere il suo programma, deve utilizzare dei TAG, ovvero parole chiave precedute dal simbolo "@" in riferimento a ciò che vuole scrivere. I tipi di TAG fondamentali sono:

@author ----> Autore della classe

@version ----> Versione della classe

@param parametro -----> Descrizione del parametro di un meotodo

@return --------> Descrizione del valore di ritorno di un metodo

@exception oppure @throws ------> Descrizione di una eccezione sollevata da un metodo

@see -------> Inserzione di un riferimento

Answer 3

Javadoc è un meccanismo all'interno di java che permette di creare dei file di documentazione, sulla base HTML. Esso viene generato attraverso i commenti, usando i tag:

@autor = autore della classe;

@version = versione della classe;

@param = descrizione del parametro in un metodo;

@return = descrizione del valore di ritorno un metodo;

@exception , @trows = descrizione di una eccezione rilevata nel metodo;

@see =  inserzione di un riferimento;

 

Ogni commento da inserire in javadoc deve essere posto prima del metodo o attributo che si vuole descrivere.