Javadoc使用@value在内部类常量上显示值

时间:2012-07-11 06:39:51

标签: java annotations constants javadoc

我有一个内部类,它声明了一个常量,并希望使用@value注释在封闭的顶级类的Javadoc中显示它的值。例如:

/**
 * {@value #FOO_CONS} // this displays well
 * {@value #BAR_CONS} // this does not work (checked in the latest Eclipse)
 * {@value Bar#BAR_CONS} // this does not work, either
 */
public Foo {
  public static final int FOO_CONS = 1;
  static class Bar {
    public static final int BAR_CONS = 42;
  }
}

如何在Foo类(或任何其他类,一般)的Javadoc中显示BAR_CONS的值?

2 个答案:

答案 0 :(得分:9)

另一个包中定义的常量的Javadoc格式应为:
{@value package.class#field}

然而,它可能不会呈现是一个已知问题:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=342194

答案 1 :(得分:2)

如果为具有可见性“package”的成员创建javadoc(这是Bar类的可见性),我将在Foo.Bar下的javadoc中获取常量