Risposte:
Questo crea un'intestazione "Vedi anche" contenente il collegamento, ovvero:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
verrà visualizzato come:
Vedi anche:
http://google.com
mentre questo:
/**
* See <a href="http://google.com">http://google.com</a>
*/
creerà un collegamento in linea:
Vedi http://google.com
<a href="http://google.com" target="_top">http://google.com</a>.
Il motivo per l'aggiunta di target = "_ top" è perché alcuni dei file html javadoc generati fanno uso di frame e probabilmente si desidera che la navigazione influenzi l'intera pagina anziché solo il frame corrente.
Tratto dalle specifiche javadoc
@see <a href="URL#value">label</a>
: Aggiunge un collegamento come definito da URL#value
. Il URL#value
è un URL relativo o assoluto. Lo strumento Javadoc distingue questo dagli altri casi cercando un simbolo minore di ( <
) come primo carattere.
Per esempio : @see <a href="http://www.google.com">Google</a>
Javadocs non offre strumenti speciali per collegamenti esterni, quindi dovresti semplicemente usare HTML standard:
See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.
o
@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of
the Martian invasion.
Non utilizzare {@link ...}
o {@linkplain ...}
perché questi sono per collegamenti ai javadocs di altre classi e metodi.
Basta usare un collegamento HTML con un elemento-like
<a href="URL#value">label</a>
Difficile trovare una risposta chiara dal sito Oracle. Quanto segue proviene da 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 con il {@link ...}
?
<a>
.
{@link package.class#member label}
@see
tag arriva dopo i tag@param
/@return
e prima dei tag@since
/@serial
/@deprecated
.