Answers:
这将创建一个包含链接的“另请参阅”标题,即:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
将呈现为:
另请参见:http :
//google.com
而这:
/**
* See <a href="http://google.com">http://google.com</a>
*/
将创建一个嵌入式链接:
<a href="http://google.com" target="_top">http://google.com</a>.
添加target =“ _ top”的原因是因为某些生成的javadoc html文件使用了框架,并且您可能希望导航影响整个页面,而不只是影响当前框架。
@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的链接。
只需使用带有a元素的HTML链接,例如
<a href="URL#value">label</a>
从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";
<a>
HTML标签的意义是什么{@link ...}
?
@see
标签来后的@param
/@return
标签和之前的@since
/@serial
/@deprecated
标签。