局部变量的 Javadoc？

Question

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

Answer 1

可以使用注释来完成。

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

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

并在你的局部变量上使用它:

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

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