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