Javadoc 中如何链接外部 URL | Java Debug 笔记

本文正在参加「Java主题月 - Java Debug笔记活动」，详情查看 活动链接

问题

Javadoc 中如何链接外部 URL ？类似于：

/**
 * See {@linktourl http://google.com}
 */

回答

回答 1

使用上述方法将创建一个叫做 See Also 标题的链接，即：

/**
 * @see <a href="http://google.com">http://google.com</a>
 */

展示给我们的信息就是：

See Also：

google.com

而使用如下的方式将创建一个内联链接：

/**
 * See <a href="http://google.com">http://google.com</a>
 */

展示给我们的信息就是：

See：google.com

回答 2

@see <a href="URL#value">label</a>：添加一个由 URL#value 所定义的链接，URL#value 的值是一个相对或绝对 URL 地址。Javadoc 工具通过寻找小于符号 < 作为第一个字符来区分这种情况，比如：

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

回答 3

Javadoc 工具并没有为外部链接提供任何特殊的工具，所以我们需要使用标准的 HTML，可以使用如下两种形式中的一种：

See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.

@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of 
the Martian invasion.

不要使用 {@link …} 或者 {@linkplain …}，因为这两种连接都会指向其他类和方法的 Javadoc。

回答 4

在 Oracle 官网中难以找到一个明确的答案，以下解释来源于 javax.ws.rs.core.HttpHeaders.java.

/**
 * See {@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">HTTP/1.1 documentation</a>}.
 */
public static final String ACCEPT = "Accept";

/**
 * See {@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2">HTTP/1.1 documentation</a>}.
 */
public static final String ACCEPT_CHARSET = "Accept-Charset";

出处

文章翻译自 Stack Overflow：Linking to an external URL in Javadoc?