Javadoc 链接到另一个包中的类

我有两个包，Shapes和 Fruits:

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

我正在为 Apple编写 JavaDoc，需要为 Square提供一个 {@link}。

我尝试了以下所有方法，但没有一个奏效:

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

我已经能够找到文档来链接到: (a)同一个包中的类，或者(b)外部 URL，但不能链接到另一个包中的类。

有什么想法正确的语法应该是什么? 谢谢！

56074 次浏览

小开

最佳答案

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

您丢失了一个完整的包

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

小开

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

{@link  package.class#member  label}

对你来说，这应该是:

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

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

小开

这个问题已经很老了，但是对于任何有类似问题的人来说，这个问题又增加了另一个答案。

使用 @see将提供一个可单击的链接，以转到指定的类或方法，因为该类(如果存在于另一个包中)是导入的。

如果所引用的类/方法位于另一个模块中，那么您必须在当前模块中添加该模块的依赖项，以便@see 可以为您提供一个可单击的链接。

/**
*     @see com.myproject.Square#method(int)
*/