如何编写 javadoc 链接？答案

【问题标题】：How to write javadoc links?如何编写 javadoc 链接？
【发布时间】：2010-10-16 12:47:20
【问题描述】：

如何将链接写入 javadocs？

目前，我有类似的东西：

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

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

【问题讨论】：

oracle.com/technetwork/java/javase/documentation/…

标签： hyperlink javadoc

【解决方案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)。

【讨论】：

对于第一个变体（当您在 URL 中包含 package-list 时），javadoc documentation page 页面显示参数 packagelistLoc (引用）：不要包含 package-list 文件名。所以这几乎解释了一切。

【解决方案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。

【讨论】：

你的确切答案对我不起作用，但你给了我需要的东西。
链接没有格式错误——你可以提供一个文本字符串作为链接标签作为@link的第二个参数。
@mipadi：哦！在我所有的 Java 编程生涯中，我从未见过这种情况。谢谢你让我知道。我会更正我的答案。

【解决方案3】：

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

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

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

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

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

【讨论】：

【解决方案4】：

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

【讨论】：

链接已失效。这就是为什么我们不在 stackoverflow（或一般的堆栈交换）上发布链接的原因。