Javadoc链接到另一个包中的类 [英] Javadoc linking to a class in another package

问题描述

我有两个软件包，Shapes和Fruits:

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

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

I am writing the JavaDoc for Apple and need to provide an {@link} to Square.

我尝试了以下所有方法，但都无济于事:

I have tried all of the following, and none of them work:

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

我已经找到链接到以下文档的文档:(a)同一软件包中的类，或(b)外部URL，但不包含另一个软件包中的类.

I've been able to find documentation for linking to: (a) classes within the same package, or (b) externals URLs, but not classes in another package.

任何想法都应该是正确的语法吗?谢谢！

Any ideas what the correct syntax should be? Thanks!

推荐答案

正确的语法变体

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

您缺少完整的包装.下面的例子应该是正确的

You were missing a complete package. The following example should be correct

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

这篇关于Javadoc链接到另一个包中的类的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！