Короткий вопрос: возможно ли создать Javadoc для локальных переменных? (Мне просто нужно пояснить мою локальную переменную, зависающую над ней в Eclipse) Спасибо за любой намек: -)
Javadoc для локальных переменных?
Ответ 1
Это можно сделать, используя Annotations
.
Создайте простой тип аннотации, например:
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.LOCAL_VARIABLE)
@interface LocalVariableDocumentation {
String value();
}
И используйте его по локальной переменной:
@LocalVariableDocumentation("A very important object!")
Object anImportantObject;
Eclipse покажет аннотацию в всплывающей подсказке.
Ответ 2
Нет, он не поддерживается, потому что генерация JavaDoc будет игнорировать его.
Ответ 3
Локальная переменная должна быть объявлена на несколько строк выше ее использования. Просто используйте регулярные комментарии, если вам нужно. Но что более важно, держите методы короткими, выберите для них значащие имена и объявите их только тогда, когда они вам понадобятся. Большую часть времени совершенно не нужно комментировать локальные переменные.
Предпочитают
int numberOfBooks = books.size();
над
// the number of books
int n;
... // 50 lines of code
n = books.size();
Ответ 4
Единственный возможный способ - это глобальные переменные. Локальные переменные не могут быть аннотированы с помощью JavaDoc.
Ответ 5
Просто сделайте ссылку на свою локальную переменную
String someLocalVariable;
/**
* This a local variable: {@link #someLocalVariable}
*/
Ответ 6
Да, это возможно. Просто сделайте регулярный комментарий javadoc над переменной.
public class ExampleClass {
/** A really cool variable */
int localVariable;
...
Теперь вы можете навешиваться над переменной в коде ниже, а комментарий будет показан.