在javadoc括号中编写@value删除 - Eclipse

Question

我想在Eclipse中编写javadoc。 我有这段代码：

private int variable;

当我想在Eclipse上面添加@value parametar时，我得{@value}而不是@value。当我想添加@author时，我得到的输出没有{}括号，正如我想要的那样。如何在没有括号的情况下获得@value？

Answer 1

由于@value标记出现在正在运行的文本中，因此它应该在大括号中。它不是像@author这样的标签，它发生在最后，基本上将文本视为下一个（无支撑）标签作为其参数。

所以Eclipse的建议是正确的。为什么要在没有大括号的情况下使用该标签？

Javadoc工具将使用其文档的常量（如果没有给出参数）或参数中提到的常量值替换@value标记。例如：

/** The value {@value}. */
public static int aConstant = 1;

/** 
 * Does something.
 * @param aValue should be {@value #aConstant}.
 * @return 42
 */
public int aMethod(int aValue) {
    ...
}