Javadoc dla zmiennych lokalnych?

Question

Krótkie pytanie: Czy można utworzyć Javadoc dla zmiennych lokalnych? (Chcę tylko objaśnić moją zmienną lokalną po najechaniu na nią w Eclipse) Dzięki za podpowiedź :-)

Answer 1

Zmienna lokalna powinna zostać zadeklarowana kilka linii powyżej jej użycia. Po prostu użyj regularnych komentarzy, jeśli potrzebujesz. Ale co ważniejsze, utrzymuj metody krótkie, wybieraj dla nich wymowne nazwy i deklaruj je tylko wtedy, gdy ich potrzebujesz. W większości przypadków nie jest konieczne komentowanie zmiennych lokalnych.

Wolę

int numberOfBooks = books.size(); 

nad

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

Answer 2

Nie, to nie jest obsługiwany, ponieważ pokolenie JavaDoc będzie go zignorować.

Answer 3

Tak, jest to możliwe. Po prostu dokonaj regularnego komentarza javadoc nad zmienną.

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

    ... 

Teraz można ustawić kursor nad zmienną w kodzie położonym niżej, a komentarz zostanie wyświetlony.

Answer 4

Można to zrobić za pomocą Annotations.

Tworzenie prostych typ adnotacji, takich jak:

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

i używać go na swojej zmiennej lokalnej:

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

Eclipse pojawi się adnotacja w dymku.

Answer 5

Jedyny możliwy sposób na zmienne globalne. Zmiennych lokalnych nie można adnotować za pomocą JavaDoc.

Answer 6

Tylko link do zmiennej lokalnej

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