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

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

Answer 3

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

体型

int numberOfBooks = books.size();

在

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

Answer 4

唯一可行的方法是使用全局变量。无法使用JavaDoc注释局部变量。

Answer 5

只需链接到您的本地变量

String someLocalVariable;
/**
 * This a local variable: {@link #someLocalVariable}
 */

Answer 6

是的，这是可能的。只需在变量上面做一个常规的javadoc注释。

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

    ...

现在您可以将代码中的变量悬停在代码上方，并显示注释。