2009-07-04 104 views

回答

886

這產生了 「請參見」 標題包含鏈接,即:

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

167

javadoc spec

@see <a href="URL#value">label</a>摘自: 添加由URL#value定義的鏈接。 URL#value是相對或絕對URL。 Javadoc工具通過尋找一個小於號(<)作爲第一個字符來區別於此。

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

+0

奇怪;我發誓我只加了反引號;我不知道這個例子在哪裏... – Stobor 2009-07-04 11:57:29

+0

我認爲我們有某種併發編輯問題。我也把他們放進去。 – Aaron 2009-07-04 12:00:05

+0

夠公平的。你在你的blockquote的第一行中缺少反引號,但是...... – Stobor 2009-07-04 12:06:11

8

只需使用帶有一個元素的HTML鏈接一樣

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

2

很難找到從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"; 
21

的Javadoc沒有對外部鏈接提供任何特殊的工具,所以你應該只使用標準的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. 

別t使用{@link ...}{@linkplain ...},因爲這些鏈接指向其他類和方法的javadoc。