问题 Javadoc用于局部变量?


简短的问题:是否可以为局部变量创建Javadoc? (我只是想在Eclipse中将鼠标悬停在我的局部变量上时的解释)感谢任何提示:-)


1035
2018-05-12 18:27


起源

您可以在方法的JavaDoc注释中包含变量描述 - Aleksandr Kravets
有时当你必须调试其他人的代码和局部变量很乱时,它会有所帮助。 - Ced


答案:


它可以使用 Annotations

创建一个简单的注释类型,如下所示:

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

并在您的本地变量上使用它:

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

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


7
2018-03-09 11:11



很好的解决方案,为什么不接受这个答案? - Ced


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


4
2018-05-16 06:27





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

比较喜欢

int numberOfBooks = books.size();

过度

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

3
2018-05-12 18:31



我同意这是不必要的 大多数时候,但是有些东西比书籍和这些东西更复杂,特别是在进行更复杂的计算等时。 - stefan.at.wpf


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


2
2017-09-09 11:34





只需链接到您的本地变量即可

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

0
2017-11-04 23:37



这对Eclipse Mars不起作用,是吗? - Ced


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

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

    ...

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


-3
2018-04-29 07:02



这对我不起作用 - Devid
我也以为是这种情况。也许它是Eclipse的旧版本。 - jonS90