Javadoc 链接到另一个包中的类

Question

我有两个包， Shapes 和 Fruits ：

 com.myproject.Shapes.
    Circle
    Square
    Triangle
com.myproject.Fruits.
    Apple
    Orange

我正在为 Apple 编写 JavaDoc，需要提供一个 {@link} 到 Square 。

我已经尝试了以下所有方法，但都不起作用：

 {@link Square}
{@link com.myproject.Square}

我已经能够找到链接到的文档：(a) 同一包中的类，或 (b) 外部 URL，但不是另一个包中的类。

知道正确的语法应该是什么吗？谢谢！

原文由 IAmYourFaja 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

正确的语法 变体是

{@link [<package>.]<class>[#<method>]}
{@link #<method>}

你错过了一个完整的包裹。下面的例子应该是正确的

{@link com.myproject.Shapes.Square}
                     ^^^^^^

原文由 Johan Sjöberg 发布，翻译遵循 CC BY-SA 3.0 许可协议

Answer 2

对于另一个包，使用此语法：

 {@link  package.class#member  label}

在您的情况下，这应该是：

 {@link com.myproject.Shapes.Square Square}

如果只想显示类名，则使用标签，如果需要完整路径，则不需要标签。

参考： http ://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#link

原文由 Pranav Shah 发布，翻译遵循 CC BY-SA 3.0 许可协议