Javadoc 链接到另一个包中的类

Question

我有两个包，Shapes 和 Fruits：

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

我正在为 Apple 编写 JavaDoc，需要提供 {@link}< /code> 到 正方形。

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

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

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

有什么想法正确的语法应该是什么吗？谢谢！

Answer 1

正确的语法变体是

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

您错过了完整的包装。下面的例子应该是正确的

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

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

Answer 3

这个问题很老了，但为有类似问题的人添加另一个答案。

使用 @see 将为您提供一个可单击的链接，以转到指定的类或方法，前提是该类（如果存在于另一个包中）已导入。

如果引用的类/方法位于另一个模块中，则必须在当前模块中添加该模块的依赖项，以便 @see 可以为您提供可单击的链接。

/**
 *     @see com.myproject.Square#method(int)
 */