首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >Javadoc链接到另一个包中的类

Javadoc链接到另一个包中的类
EN

Stack Overflow用户
提问于 2011-09-03 01:52:50
回答 3查看 52.8K关注 0票数 70

我有两个包,ShapesFruits

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

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

我已经尝试了以下所有方法,但都不起作用:

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

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

你知道正确的语法应该是什么吗?谢谢!

EN

回答 3

Stack Overflow用户

回答已采纳

发布于 2011-09-03 01:56:22

correct syntax的变体是

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

你遗漏了一个完整的包裹。下面的示例应该是正确的

{@link com.myproject.Shapes.Square} 
                     ^^^^^^
票数 93
EN

Stack Overflow用户

发布于 2013-02-27 03:39:56

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

{@link  package.class#member  label}

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

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

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

参考:http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#link

票数 20
EN

Stack Overflow用户

发布于 2021-02-06 01:14:27

这个问题很老了,但对于任何有类似问题的人来说,都可以添加另一个答案。

如果某个类存在于另一个包中,则使用@see将为您提供一个可单击的链接,以转到指定的类或方法。

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

/**
 *     @see com.myproject.Square#method(int)
 */
票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/7287374

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档