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?
risposta
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
- 1. PowerShell Variabili globali variabili locali
- 2. Editing Eclipse Javadoc $ {tag} variabili
- 3. Variabili locali MySQL
- 4. Variabili locali passate (C++)
- 5. variabili locali: Programmazione Pratiche
- 6. Variabili di istanza Java vs variabili locali
- 7. Rails - Variabili locali contro variabili di istanza
- 8. accesso tutte le variabili locali
- 9. variabili Constructor-locali a Scala
- 10. Accesso globale vs. variabili locali
- 11. ritorno riferimenti a variabili locali
- 12. setjmp/longjmp e variabili locali
- 13. Multithreading, lambda e variabili locali
- 14. Parser JavaDoc per javadoc comuni?
- 15. Variabili locali all'interno dell'istruzione if
- 16. SQL CASE e variabili locali
- 17. Variabili locali all'interno di aes
- 18. variabili locali in bytecode Java
- 19. Javadoc più variabili in un'unica linea
- 20. Come definire variabili locali statiche locali del thread?
- 21. bytecode Java: tipi di variabili locali?
- 22. C++ variabili locali e thread (non thread_local)
- 23. Variabili locali prima dei rendiconti, è importante?
- 24. Le variabili globali e locali in R
- 25. Valori predefiniti di variabili di istanza e variabili locali
- 26. script bash leggere le variabili di file in variabili locali
- 27. Come utilizzare variabili locali in un'espressione lambda
- 28. variabili locali nelle definizioni di classe/ambito
- 29. Blocchi, loops e le variabili locali
- 30. Tipizzazione implicita; perché solo variabili locali?
È 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