java - 链接到 Javadoc 中的外部 URL？

Question

就像是：

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

Answer 1

这将创建一个包含链接的“另见”标题，即：

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

将呈现为：

另请参阅：http:
           //google.com

而这个：

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

将创建一个内联链接：

请参阅http://google.com

Answer 2

取自javadoc 规范

@see <a href="URL#value">label</a>: 添加由 定义的链接URL#value。这URL#value是一个相对或绝对 URL。Javadoc 工具通过查找小于号 ( <) 作为第一个字符来将此与其他情况区分开来。

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

Answer 3

Javadocs 不为外部链接提供任何特殊工具，因此您应该只使用标准 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 ...}or{@linkplain ...}因为这些是指向其他类和方法的 javadocs 的链接。

Answer 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";