如何编写javadoc链接？

Question

如何将链接写入javadocs？

目前，我有类似的内容：

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

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

Answer 1

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

如果我这样做：

    javadoc -linkoffline http://java.sun.com/javase/6/docs/api/ 
                         http://java.sun.com/javase/6/docs/api/package-list
            -public FileName.java

然后javadoc抱怨：

    javadoc: warning - Error fetching URL: 
    http://java.sun.com/javase/6/docs/api/package-list/package-list

另一方面，如果我这样做：

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

然后它可以工作，我的链接就像我希望的那样填充。

此外，我的链接没有格式错误。文字{@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。

Answer 3

This document可能会有所帮助，请记住，对于@link，您需要使用您要链接的文档的URL。