Javadoc链接到另一个包中的类

Question

我有两个包,Shapes并且Fruits:

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

我正在编写JavaDoc Apple并且需要提供一个{@link}to Square.

我已经尝试了以下所有方法,但没有一个工作:

{@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