java - javadoc中的字符串内容

Question

我想知道，是否可以为公共字符串常量生成 javadoc 以生成包含其内容的 javadoc？例如对于字段：

public static final String MENU = "menu_2";

它会像这样生成javadoc：

 /**
  * value: menu_2
  */

Answer 1

可以直接在评论中引用：

/**
 * MENU static field whose value is: {@value #MENU}
 */
public static final String MENU = "menu_2";

Answer 2

使用价值标签/**value: {@value}*/。有关 javadoc 标签，请参阅此链接：http: //docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#javadoctags。

Answer 3

不使用标准的 javadoc 工具。编辑我的立场得到纠正，谢谢@Aleksandr！

我也建议不要这样做。您应该使用 javadoc 向该字段添加上下文。例如，该字段是什么意思？不仅仅是写字段的值是什么。任何人都可以查看代码以找出该值。大多数 IDE 也可以为您检索它。在 Eclipse 中，将鼠标悬停在引用上时按住 SHIFT 键将为您提供声明。