链接到Javadoc中的外部URL?


Answers:


1223

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

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


59
如果有人有兴趣,因为我不得不看它:根据的Javadoc规范@see标签来@param/ @return标签和之前@since/ @serial/ @deprecated标签。
friederbluemle

7
以防万一,Intellij 13似乎不支持此标签。它确实支持嵌入式链接。标签是否已过时?
2014年

24
我建议<a href="http://google.com" target="_top">http://google.com</a>. 添加target =“ _ top”的原因是因为某些生成的javadoc html文件使用了框架,并且您可能希望导航影响整个页面,而不只是影响当前框架。
安东尼

3
如果收到“警告-标记\ @see:缺少最后一个'>':”之类的警告,请确保在同一\ @see指令中没有两个超链接。而是,每个\ @see使用一个链接。
特拉维斯·斯宾塞

7
为什么将URL链接添加到javadoc如此复杂?谁以为HTML是个好主意呢?/ facepalm
Somewhere Somewhere

189

取自javadoc规范

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

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


奇怪的; 我发誓我只会加入反引号。我不知道示例去了哪里……
Stobor

我认为我们遇到了某种并发编辑问题。我也把它们放进去。
亚伦2009年

很公平。但是,您在blockquote的第一行中缺少反引号。–
Stobor

27
不需要@see。javadocs可以使用html标签格式化,因此仅需使用“ a”标签。
加布里埃尔·拉马斯

5
@GabrielLlamas是的,但最初的问题暗示这是如何使用它。知道它确实在“另见”字段中确实有用,这是很有用的,这是很多人想要的。
Ionoclast Brigham

33

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的链接。


16

只需使用带有a元素的HTML链接,例如

<a href="URL#value">label</a>


只是重新发布了正确的答案,因为它来自其他评论。这将比整个线程更快地读取。
MaxVölkel博士2014年

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

用包裹<a>HTML标签的意义是什么{@link ...}
Patrick M

2
这可能是一个错误,因为javadoc文档未提及此格式,因为它与raw没有区别<a>
Didier L

4
这里的{@link xxx}不正确。{@link xxx}用于链接到源代码中的其他类和方法。这里没有必要。其余的都很好。
MiguelMunoz

4
Java 8标准(doclint on)不允许使用此构造。
Stepan Vavra

1
这是完全错误的。根据参考文档的正确用法是{@link package.class#member label}
Dinei
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.