内部/嵌套类构造函数的正确“ @link”或“ @see” javadoc标记是什么?

sku*_*zmo 7 java javadoc inner-classes

我在使“ @link”和“ @see”标签适用于内部/嵌套类的构造函数时遇到了问题,希望这里有人能提供帮助。这个简短的示例类在第25行上给出了Javadoc警告,引用了“ Layer()”文档前几行中的“ @link”和(等效)“ @ see”标记。

package bogus;
import javax.swing.JPanel;
public class LayeredPlot extends JPanel {
  /**
   * Constructor for the plot.
   */
  public LayeredPlot() {
  }
  public static class Layer {
    private String name;
    /**
     * Construct a default layer with a default name. This method calls
     * {@link LayeredPlot.Layer#Layer(String)} OR calls == JAVADOC WARNING
     * {@link #Layer(String)} OR calls                  == JAVADOC WARNING
     * {@link Layer#Layer(String)}                      == JAVADOC WARNING
     * with a null name to perform the construction.
     * The constructor for the layer can be found
     * {@link LayeredPlot#LayeredPlot() here}.          == JAVADOC Okay!
     *
     * @see LayeredPlot.Layer#Layer(String)             == JAVADOC WARNING
     * @see #Layer(String)                              == JAVADOC WARNING
     * @see Layer#Layer(String)                         == JAVADOC WARNING
     * @see LayeredPlot#LayeredPlot()                   == JAVADOC Okay!
     */
    public Layer() {    // Line 25: javadoc warnings reference this line
      this(null);
    }
    /**
     * Construct a layer with the specified name.
     *
     * @param name The desired name for the layer within the plot.
     */
    public Layer(String name) {
      this.name = name;
    }
  }
}
Run Code Online (Sandbox Code Playgroud)

警告(“ @see”为3,“ @ link”为3)均表示:can't find Layer(String) in bogus.LayeredPlot.Layer

请注意: 所有其他javadocs均按预期工作(包括内部类方法和本例中我对LayeredPlot本身的构造函数的引用)。

对于内部/嵌套类构造函数的正确javadoc标记的任何建议将不胜感激。
谢谢。

vip*_*vip 5

由于错误JDK-8031625,Java 8 或更早版本没有正确的方法来做到这一点仅在 Java 9这一点。

解决方法是对类和参数使用完全限定的名称:

{@link bogus.LayeredPlot.Layer#LayeredPlot.Layer(java.lang.String)}
Run Code Online (Sandbox Code Playgroud)

但这不是句法上有效的成员名称,因此有几个工具会抱怨(doclint、checkstyle)。


cta*_*ate 1

如果要确定内部名称的范围,则需要在 # 标记的两侧对其进行完全范围化。例如:

@see LayeredPlot.Layer#LayeredPlot.Layer(String)
Run Code Online (Sandbox Code Playgroud)