【问题标题】:Javadoc linking to a class in another packageJavadoc 链接到另一个包中的类
【发布时间】:2011-11-09 09:13:35
【问题描述】:

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

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

【问题讨论】:

  • 定义“它们都不起作用”?发生什么了?你的语法是正确的 ({@link com.myproject.Square})

标签: java javadoc


【解决方案1】:

这个问题已经很老了,但是为任何有类似问题的人添加另一个答案。

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

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

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

【讨论】:

    【解决方案2】:

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

    {@link  package.class#member  label}
    

    在你的情况下应该是:

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

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

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

    【讨论】:

      【解决方案3】:

      correct syntax 变体是

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

      您缺少一个完整的包裹。下面的例子应该是正确的

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

      【讨论】:

      • 既然语法是{@link package.class},不应该是{@link com.myproject.Shapes.Square} 吗?
      • 类是 Shapes.Square 而不仅仅是 Square 所以它应该读为 {@link com.myproject.Shapes.Square}
      • {@link com.myproject.Shapes.Square square} 是一个以“square”为文本的链接。
      • 是否有简写版本,类似于目录的工作方式?例如:..// ?
      猜你喜欢
      • 2016-02-21
      • 1970-01-01
      • 1970-01-01
      • 2014-10-26
      • 1970-01-01
      • 2010-11-08
      • 2011-04-10
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多