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，但不包含其他包中的类。

任何想法应该是正确的语法？谢谢！

Answer 1

correct syntax变种

{@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)
 */