16

简短的问题：是否可以为局部变量创建 Javadoc？（我只想在 Eclipse 中将鼠标悬停在局部变量上时对其进行解释）感谢您的任何提示 :-)

4

6 回答 6

11

可以使用Annotations.

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

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

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

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

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

于 2015-03-09T11:11:24.920 回答
5

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

于 2012-05-16T06:27:51.390 回答
4

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

更喜欢

int numberOfBooks = books.size();

超过

// the number of books
int n;
... // 50 lines of code
n = books.size();
于 2012-05-12T18:31:00.817 回答
2

只需链接到您的本地变量

String someLocalVariable;
/**
 * This a local variable: {@link #someLocalVariable}
 */
于 2016-11-04T23:37:27.980 回答
2

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

于 2016-09-09T11:34:01.890 回答
-3

是的，这是可能的。只需在变量上方进行常规 javadoc 注释即可。

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

    ...

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

于 2014-04-29T07:02:20.937 回答