Javadoc 链接到另一个包中的类

java javadoc

2022-08-31 13:40:06

我有两个包，并且：ShapesFruits

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

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

我已经尝试了以下所有方法，但没有一个起作用：

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

我已经能够找到链接到以下位置的文档：（a）同一包中的类，或（b）外部URL，但不是另一个包中的类。

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

答案 1

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

您缺少一个完整的软件包。以下示例应是正确的

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

答案 2

对于另一个包，请使用以下语法：

{@link  package.class#member  label}

在你的情况下，这应该是：

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

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