协慌网

登录 贡献 社区

链接到 Javadoc 中的外部 URL?

就像是:

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

答案

这将创建一个包含链接的 “另请参阅” 标题,即:

/**
 * @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

取自javadoc 规范

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

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

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 ...}{@linkplain ...}因为它们是指向其他类和方法的 javadocs 的链接。