hyperlink - 如何编写 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 版本时）

如果我做：

    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：警告 - 获取 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

我相信对于你想要做的事情，你可以这样做：

@see java.lang.Math#sqrt(double)

它不会为您提供替代文本，但会为您提供链接。

您还可以编写更通用的链接，例如使用标准 html：

<a href="http://www.google.com">Google</a>

Answer 4

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