Javadoc链接到另一个包中的类

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (210)

我有两个包,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,但不包含另一个包中的类。

正确的语法应该是什么?谢谢!

提问于
用户回答回答于

正确的语法变种

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

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

{@link com.myproject.Shapes.Square} 
                     ^^^^^^
用户回答回答于

对于另一个包使用此语法:

{@link  package.class#member  label}

在你的情况下,这应该是:

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

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

扫码关注云+社区

领取腾讯云代金券