Вопрос по javadoc, java, local-variables, eclipse – Javadoc для локальных переменных?

12

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

Вы можете включить описание переменной в комментарий JavaDoc метода Aleksandr Kravets
Иногда, когда приходится отлаживать код другого человека, а локальные переменные беспорядочные, это поможет. Ced

Ваш Ответ

6   ответов
9

Annotations.

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

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

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

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

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

Отличное решение, почему этот ответ не принят? Ced
0

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

String someLocalVariable;
/**
 * This a local variable: {@link #someLocalVariable}
 */
Это не работает на Eclipse Mars, не так ли? Ced
4

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

-3

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

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

    ...

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

Это не работает для меня Devid
Я тоже думал, что это так. Может быть, это была более старая версия Eclipse. jonS90
3

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

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

int numberOfBooks = books.size();

на

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

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

Похожие вопросы