Respostas:
Isso cria um cabeçalho "Consulte também" contendo o link, ou seja:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
renderizará como:
Veja também:
http://google.com
considerando que isto:
/**
* See <a href="http://google.com">http://google.com</a>
*/
criará um link in-line:
Veja http://google.com
<a href="http://google.com" target="_top">http://google.com</a>.
O motivo da adição de target = "_ top" é porque alguns dos arquivos javadoc html gerados fazem uso de quadros, e você provavelmente deseja que a navegação afete a página inteira, e não apenas o quadro atual.
Retirado da especificação javadoc
@see <a href="URL#value">label</a>
: Adiciona um link conforme definido por URL#value
. O URL#value
URL é relativo ou absoluto. A ferramenta Javadoc distingue isso de outros casos, procurando por um símbolo menor que ( <
) como o primeiro caractere.
Por exemplo : @see <a href="http://www.google.com">Google</a>
Os Javadocs não oferecem nenhuma ferramenta especial para links externos; portanto, você deve usar apenas o html padrão:
See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.
ou
@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of
the Martian invasion.
Não use {@link ...}
ou {@linkplain ...}
porque estes são para links para os javadocs de outras classes e métodos.
Basta usar um link HTML com um elemento a como
<a href="URL#value">label</a>
Difícil encontrar uma resposta clara no site da Oracle. O seguinte é de 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>
tag html com o {@link ...}
?
<a>
.
{@link package.class#member label}
@see
tag vem após as tags@param
/@return
e antes das@since
/@serial
/@deprecated
.