Question

我在使用“@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;
    }
  }
}

警告（3表示“@see”，3表示“@link”）都说：can't find Layer(String) in bogus.LayeredPlot.Layer。

请注意：所有其他javadoc按预期工作（包括内部类方法和本例中我对LayeredPlot本身的构造函数的引用）。

非常感谢内部/嵌套类构造函数的正确javadoc标记的任何建议感谢。

Answer 1

没有正确的方法可以使用Java 8或更早版本，因为bug JDK-8031625只能在Java 9中修复。

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

{@link bogus.LayeredPlot.Layer#LayeredPlot.Layer(java.lang.String)}

但这不是一个语法上有效的成员名称，所以有几个工具会抱怨（doclint，checkstyle）。

Answer 2

如果您根本调整内部名称的范围，则需要在＃标记的两侧完全限定它。 E.g：

@see LayeredPlot.Layer#LayeredPlot.Layer(String)

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

2 个答案: