这将创建一个包含链接的“另见”标题,即:
/**
* @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 spec
@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。
很难从 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";
{@link ...}
包装 <a>
html 标记有什么意义?
<a>
没有区别。
@see
标签位于 after@param
/@return
标签和 before i>@since
/@serial
/@deprecated
标签。<a href="http://google.com" target="_top">http://google.com</a>.
添加 target="_top" 的原因是因为一些生成的 javadoc html 文件使用框架,并且您可能希望导航影响整个页面而不仅仅是当前框架。