Javadoc para variables locales?

Question

Pregunta breve: ¿Es posible crear Javadoc para variables locales? (Solo quiero una explicación para mi variable local al pasar sobre ella en Eclipse) Gracias por cualquier sugerencia :-)

Answer 1

La variable local debe declararse unas líneas arriba de su uso. Simplemente use comentarios regulares si es necesario. Pero lo más importante es mantener los métodos cortos, elegir nombres significativos para ellos y declararlos solo cuando los necesite. La mayoría de las veces, es completamente innecesario comentar las variables locales.

Prefiero

int numberOfBooks = books.size(); 

sobre

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

Answer 2

No, no es compatible, ya la generación de JavaDoc lo ignorará.

Answer 3

Sí, es posible. Simplemente haga un comentario regular de javadoc sobre la variable.

public class ExampleClass { 
    /** A really cool variable */ 
    int localVariable; 

    ... 

Ahora puede pasar el cursor sobre la variable en el código más abajo y se mostrará el comentario.

Answer 4

Se puede hacer usando Annotations.

Crear un simple tipo de anotación como las siguientes:

@Retention(RetentionPolicy.SOURCE) 
@Target(ElementType.LOCAL_VARIABLE) 
@interface LocalVariableDocumentation { 
    String value(); 
} 

y utilizarlo en su variable local:

@LocalVariableDocumentation("A very important object!") 
Object anImportantObject; 

Eclipse mostrará la anotación en la descripción.

Answer 5

La única forma en que es posible es con variables globales. Las variables locales no pueden anotarse con JavaDoc.

Answer 6

Sólo hacer un enlace a su variable local

String someLocalVariable; 
/** 
* This a local variable: {@link #someLocalVariable} 
*/