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

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

 Aleksandr Kravets16 мая 2012 г., 08:31
Вы можете включить описание переменной в комментарий JavaDoc метода
 Ced20 нояб. 2017 г., 17:06
Иногда, когда приходится отлаживать код другого человека, а локальные переменные беспорядочные, это поможет.

Ответы на вопрос(6)

Annotations.

Создайте простой тип аннотации, такой как следующий:

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

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

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

Eclipse покажет аннотацию во всплывающей подсказке.

 Ced20 нояб. 2017 г., 17:00
Отличное решение, почему этот ответ не принят?

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

String someLocalVariable;
/**
 * This a local variable: {@link #someLocalVariable}
 */
 Ced20 нояб. 2017 г., 17:02
Это не работает на Eclipse Mars, не так ли?

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

это возможно. Просто сделайте обычный комментарий Javadoc над переменной.

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

    ...

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

 Devid30 июн. 2014 г., 22:58
Это не работает для меня
 jonS9006 сент. 2017 г., 21:35
Я тоже думал, что это так. Может быть, это была более старая версия Eclipse.

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

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

int numberOfBooks = books.size();

на

// the number of books
int n;
... // 50 lines of code
n = books.size();
 stefan.at.wpf12 мая 2012 г., 20:46
Я согласен, что это не нужнобольшую часть времен, но есть вещи, которые сложнее объяснить, чем количество книг и тому подобное, особенно при выполнении более сложных вычислений и т. д.

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

Ваш ответ на вопрос