Come documentare il mio metodo in Java come i documenti Java?

Question

Voglio che quando passo il mouse su un metodo potrei vedere la mia documentazione di come il metodo quando metto il mouse sopra il metodo di Java so che/** */è come è fatto ma:

1. Come spieghi per che cosa si posiziona Params?

2. Come si crea una nuova riga o si crea una parola in grassetto o in corsivo?

Answer 1

Se stai usando Eclipse come IDE, è solo bisogno di creare un commento con

/** 

e premere Invio e genererà il codice per Javadoc, inclusi parametri, valori di ritorno, ecc. È sufficiente inserire le descrizioni.

Lo stesso vale per le dichiarazioni di classe (il commento Javadoc si riferisce sempre al seguente elemento)

Nota:

Per allegare doc per il metodo è necessario specificare il nome del metodo nei commenti in alto .

Per esempio

/** 
* create_instance 
* @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
* respectively. 
* @return Instance object 
*/ 

Answer 2

Come si spiega ciò che sta alla Params per?

Uso @param tag:

/** 
* @param paramName Explanation of the param 
*/ 
public void foo(String paramName); 

Come si fa a creare una nuova linea, o fare una parola in grassetto o corsivo?

Usa HTML standard, vale a dire <p></p>, <br/>, <strong> e <em> (o meno semantica <b> e <i>)