链接到package-info.java中的特定部分

时间:2015-08-14 10:06:02

标签: javadoc

如何在其他地方从Javadoc链接到package-info.java文件中的特定部分?

该部分可以使用<a name="section-name">...标记指定,然后生成的链接应该有... /package-summary.html#section-name网址。但是其他指定部分的方式也很有趣。

要求:

  1. 必须能够使用package-info.java文件记录的软件包之外的软件包进行链接。
  2. 无法使用与链接源相关的网址(如..\..\p1\p2\package-info.java),因为它们很难维护。
  3. 链接应该(优选)不仅可以通过Web浏览器来理解,还可以通过IDE(最重要的是Eclipse)在其自动生成的Javadoc弹出式渲染中理解。

    我认为实现这一目标的唯一方法是不使用href而是使用{@linkplain},但我无法确定如何指定部分。

1 个答案:

答案 0 :(得分:1)

可以使用href@{docRoot}标记执行此操作:

<a href="{@docRoot}/p1/p2/package-summary.html#section-name">Section Name</a>

这不符合要求3,因为在Eclipse中,这样的链接打开Web浏览器而不是Javadoc查看器中的构建。所以,如果有人找到另一种解决方案,我将不胜感激。