局部变量的Javadoc？

Question

简短的问题:可以为局部变量创建Javadoc吗？(当我在Eclipse中将鼠标悬停在局部变量上时，我只想得到它的一个解释)谢谢你的任何提示:-)

Answer 1

这可以使用Annotations来完成。

创建一个简单的注释类型，如下所示：

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

并在您的局部变量上使用它：

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

Eclipse将在工具提示中显示注释。

Answer 2

局部变量应该在其用法之前声明几行。如果需要，只需使用常规注释即可。但更重要的是，保持方法简短，为它们选择有意义的名称，并仅在需要时声明它们。大多数情况下，注释局部变量是完全没有必要的。

首选

int numberOfBooks = books.size();

结束

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

Answer 3

不支持，因为JavaDoc生成会忽略它。