Javadoc for local variables?

Question

Short question: Is it possible to create Javadoc for local variables? (I just want an explanation for my local variable when hovering over it in Eclipse) Thanks for any hint

Answer 1

The local variable should be declared a few lines above its usage. Just use regular comments if you need to. But more importantly, keep methods short, choose meaningful names for them, and declare them only when you need them. Most of the time, it's completely unnecessary to comment local variables.

Prefer

int numberOfBooks = books.size();

over

// the number of books
int n;
... // 50 lines of code
n = books.size();