Domanda breve: è possibile creare Javadoc per variabili locali? (Voglio solo una spiegazione per la mia variabile locale al passaggio del mouse su Eclipse) Grazie per qualsiasi suggerimento :-)Javadoc per variabili locali?
La variabile locale deve essere dichiarata poche righe sopra il suo utilizzo. Usa i commenti regolari se necessario. Ma ancora più importante, mantieni i metodi brevi, scegli nomi significativi per loro e dichiarali solo quando ne hai bisogno. Il più delle volte, non è assolutamente necessario commentare le variabili locali.
Preferisco
int numberOfBooks = books.size();
oltre
// the number of books
int n;
... // 50 lines of code
n = books.size();
Sono d'accordo che non è necessario * la maggior parte del tempo *, ma ci sono solo cose che sono più complesse da spiegare rispetto al numero di libri e cose del genere, specialmente quando si fanno calcoli più complessi ecc. –
No, non è supportato a causa generazione JavaDoc lo ignorerà.
Sì, è possibile. Scrivi semplicemente un commento javadoc sopra la variabile.
public class ExampleClass {
/** A really cool variable */
int localVariable;
...
Ora è possibile passare sopra la variabile nel codice più in basso e verrà visualizzato il commento.
È possibile utilizzare Annotations.
creare un semplice tipo di annotazione come il seguente:
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.LOCAL_VARIABLE)
@interface LocalVariableDocumentation {
String value();
}
e usarlo sulla vostra variabile locale:
@LocalVariableDocumentation("A very important object!")
Object anImportantObject;
Eclipse mostrerà l'annotazione nel suggerimento.
Ottima soluzione, perché questa risposta non è accettata? – Ced
L'unico modo è possibile è con le variabili globali. Le variabili locali non possono essere annotate con JavaDoc.
Basta fare un link al tuo variabile locale
String someLocalVariable;
/**
* This a local variable: {@link #someLocalVariable}
*/
Questo non funziona su Eclipse Mars, vero? – Ced
È possibile includere descrizione variabile in JavaDoc commento di metodo –
A volte quando si deve eseguire il debug di un altro codice persona e le variabili locali sono disordinati, sarebbe d'aiuto. – Ced