Javadoc链接到另一个包
我有两个包, Shapes
和Fruits
:
com.myproject.Shapes. Circle Square Triangle com.myproject.Fruits. Apple Orange
我正在为Apple
编写JavaDoc,并需要向Square
提供一个{@link}
。
我尝试了以下所有内容,而且都没有工作:
{@link Square} {@link com.myproject.Square}
我已经能够find链接到以下内容的文档:(a)同一个包中的类,或者(b)外部URL,而不是另一个包中的类。
任何想法正确的语法应该是什么? 谢谢!
正确的语法变体是
{@link [<package>.]<class>[#<method>]} {@link #<method>}
你错过了一个完整的包。 下面的例子应该是正确的
{@link com.myproject.Shapes.Square} ^^^^^^
对于另一个包使用这个语法:
{@link package.class#member label}
在你的情况下,这应该是:
{@link com.myproject.Shapes.Square Square}
如果只想显示类名,则使用标签,如果需要完整path,则不需要标签。
参考: http : //docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#link