JavaDoc è uno strumento utilizzato per generare documentazione HTML direttamente dal file sorgente.
La documentazione delle classi predefinite dei package Java è ad esempio prodotta in questo modo

  • I commenti devono
    • cominciare con il delimitatore speciale /**
    • finire il delimitatore speciale */
  • Ogni commento viene inserito immediatamente sopra la funzione che descrive
     public class MyClass
    {
    	/** Description of myIntField */
    	public int myIntField;
    
    	/** Description of MyClass()
    	 *
    	 * @throws MyException 		Description of myException
    	 */
    	public MyClass() throws myException
    	{
    		// Blah Blah Blah...
    	}
    
    	/** Description of myMethod(int a, String b)
    	 *
    	 * @param a	Description of a
    	 * @param b	Description of b
    	 * @return	Description of c
    	 */
    	public Object myMethod(int a, String b)
    	{
    		Object c;
    		// Blah Blah Blah...
    		return c;
    	}
    }

    Uno dei vantaggi è che si mantiene codice e documentazione nello stesso file, rendendo anche il codice più esplicativo per un programmatore che si aproccia per la prima volta ad affrontare quel codice.

Lista dei tag javadoc

Tag Descrizione
@author Nome dello sviluppatore.
@deprecated (vedere sopra) indica che l’elemento potrà essere eliminato da una versione successiva del software.
@exception Indica eccezioni lanciate da un metodo; cf. @throws.
@link Crea un collegamento ipertestuale alla documentazione locale o a risorse esterna (tipicamente internet).
@param Definisce i parametri di un metodo. Richiesto per ogni parametro.
@return Indica i valori di ritorno di un metodo. Questo tag non va usato per metodi o costruttori che restituiscono void.
@see Indica un’associazione a un altro metodo o classe.
@since Indica quando un metodo è stato aggiunto a una classe.
@throws Indica eccezioni lanciate da un metodo. Sinonimo di @exception introdotto in Javadoc 1.2.
@version Indica il numero di versione di una classe o un metodo.
Annunci