Ho una classe come la seguente ...Javadoc più variabili in un'unica linea
class A{
/**
* Blah blah
*/
Type1 var;
/**
* What do I do here?
*/
Type2 var11, var12;
}
Come posso javadoc var11 e Var12 se sono entrambi sulla stessa linea?
Sono curioso di vedere se questo è possibile, so che posso metterli entrambi su una linea individuale e javadoc da lì.
ero curioso così ho provato
/**
* data stuff
*/
int x , y ;
Javadoc risultante ripetuto le stesse osservazioni doc per xey. Immagino che questo comportamento sarebbe utile se due campi fossero essenzialmente gli stessi con piccole differenze.
class Circle
{
....
/**
* center coordinates
* The x/y coordinate of the center of this circle.
*/
int x , y ;
Sì, sono arrivato anche a questa conclusione. Beh, immagino che non ci sia modo di separare il Javadoc, grazie per la tua risposta e impegno! –
Sfortunatamente, questo funziona solo con lo stesso tipo. Quindi, linee come 'testButton JButton privato, testLabel JLabel;' non funzioneranno. – Bowi
purtroppo non c'è modo di distinguere la dichiarazione singola linea di variabili multiple :(
Può essere utile notare, tuttavia, che il beneficio di questo non consente per un singolo javadoc per fornire la documentazione per le variabili categoriche che può altrimenti prendere le linee inutili.
/**
* custom colors (MUST BE DISPOSED!)
*/
Color lightblue, someotherblue, lightred;
naturalmente questo può essere combinato con l'inizializzazione così
/**
* These are the spec's behind batch-box font size/Height/Width
*/
private int iFontHeight = 9, iboxheight = 58, iboxwidth = 125;
no. Dichiarare e documentare una singola variabile per riga. – EJP