Javadoc для локальных переменных?

Question

Короткий вопрос: возможно ли создать Javadoc для локальных переменных? (Мне просто нужно объяснение для моей локальной переменной, зависящее от нее в Eclipse) Спасибо за любой намек :-)

Answer 1

Локальная переменная должна быть объявлена ​​на несколько строк выше ее использования. Просто используйте регулярные комментарии, если вам нужно. Но что более важно, держите методы короткими, выберите для них значащие имена и объявите их только тогда, когда они вам понадобятся. В большинстве случаев совершенно необязательно комментировать локальные переменные.

Предпочитают

int numberOfBooks = books.size(); 

над

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

Answer 2

Нет, это не поддерживается, потому что поколение JavaDoc будет игнорировать его.

Answer 3

Да, это возможно. Просто сделайте регулярный комментарий javadoc над переменной.

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

    ... 

Теперь вы можете навешивать над переменной в коде дальше и комментарий будет показан.

Answer 4

Это можно сделать, используя Annotations.

Создать простой тип аннотации, такие как:

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

И использовать его на локальной переменной:

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

Затмение будет показывать аннотацию в подсказке.

Answer 5

Единственный способ, которым это возможно, - это глобальные переменные. Локальные переменные нельзя аннотировать с помощью JavaDoc.

Answer 6

Просто сделать ссылку на ваш локальный переменную

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