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

2022-09-01 14:45:17

我有一个内部类,它声明一个常量,并希望使用@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;
  }
}

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


答案 1

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

但是,它可能不渲染是一个已知问题:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=342194


答案 2

如果为具有可见性“包”的成员创建javadoc(这是您的Bar类的可见性),我会在javadoc下获得常量 Foo.Bar


推荐