如何编写javadoc链接？

Question

如何将链接写入javadocs？

目前,我有类似的东西:

{@link java.lang.Math#sqrt(double) Math.sqrt}

生成Math.sqrt应该链接到java.lang.Math.sqrt(double)API 的文本,但是,它所做的只是生成文本,没有链接.

Answer 1

我的回答非常由Eddie提供,但他的确切代码对我不起作用(或者至少在使用Java 1.6附带的javadoc版本时)

如果我做:

__PRE__

然后javadoc抱怨:

__PRE__

另一方面,如果我这样做:

__PRE__

然后它工作,我的链接填充,因为我希望它们.

此外,我的链接没有格式错误.文本{@link java.lang.Math#sqrt(double) Math.sqrt}生成链接文本Math.sqrt而不是默认文本Math.sqrt(double).

Answer 2

要获取代码外部某些内容的链接,您需要使用该-linkoffline选项

在-linkoffline选项的格式是这样的(人为包裹):

-linkoffline http://java.sun.com/javase/6/docs/api/
             http://java.sun.com/javase/6/docs/api/

这告诉JavaDoc工具在哪里可以找到JavaDoc的链接以及使用该链接的包.从第二个URL,它将附加"package-list"以加载实际的URL:

http://java.sun.com/javase/6/docs/api/package-list

您可以通过在浏览器中加载它来验证它确实包含该JavaDoc URL中记录的包列表.这告诉JavaDoc工具,@link对其中一个包中的任何内容的任何引用都应该链接到提供的URL.