java - 如何在 javadoc 中使用 @value 标签？

Question

我正在使用带有私有(private)构造函数的类而不是枚举(这是一个要求)。现在我正在尝试添加 javadoc 标签来记录每个 public static final 实体。

1) 放置 javadoc 标记的首选位置:像 ob1 或 ob2？

2) 这两个选项都会在 IDEA 中产生错误@value 标签必须引用带有常量初始化器的字段。

/**
 * {@value #ob1} object1 description
 */

public class MyClass {
    public static final Object ob1 = new Object();

    /**
     * {@value #ob2} object2 description
     */ 
    public static final Object ob2 = new Object();

    private MyClass() {}   
}

Answer 1

我认为 Kayaman 的回答还不够，因为问题是如何在 javadocs 中使用 @value 标签。

我认为问题在于被引用的字段的值不是文字值。

在eclipse中，当你有

/**
 * {@value #ob2} object2 description
 */ 
public static final Object ob2 = new Object();

生成的 Javadocs 是 {@value #ob2} object2 描述。但是，当你有

/**
 * {@value #ob2} object2 description
 */ 
public static final String ob2 = "hello";

生成的 Javadocs 是 "hello"object2 描述(预期的输出)。

因此，总而言之，您在 javadocs 中正确使用了 @value 标记，但只有当字段已使用文字值初始化时，该值才会正确呈现。