链接到Javadoc中的外部URL?
就像是:
/** * See {@linktourl http://google.com} */
这将创build一个包含链接的“另请参阅”标题,即:
/** * @see <a href="http://google.com">http://google.com</a> */
将呈现为:
也可以看看:
http://google.com
而这个:
/** * See <a href="http://google.com">http://google.com</a> */
将创build一个内联链接:
采取从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 ...}
因为这些链接指向其他类和方法的javadoc。
只需使用一个类似于a元素的HTML链接
<a href="URL#value">label</a>
很难从Oracle网站上find明确的答案。 以下内容来自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";