Respuestas:
Esto crea un encabezado "Ver también" que contiene el enlace, es decir:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
se renderizará como:
Ver también:
http://google.com
mientras que esto:
/**
* See <a href="http://google.com">http://google.com</a>
*/
creará un enlace en línea:
<a href="http://google.com" target="_top">http://google.com</a>.
La razón para agregar target = "_ top" es porque algunos de los archivos html javadoc generados utilizan marcos, y probablemente desee que la navegación afecte a toda la página en lugar de solo el marco actual.
Tomado de la especificación javadoc
@see <a href="URL#value">label</a>
: Agrega un enlace según lo definido por URL#value
. El URL#value
es una URL relativa o absoluta. La herramienta Javadoc distingue esto de otros casos al buscar un símbolo menor que ( <
) como primer carácter.
Por ejemplo : @see <a href="http://www.google.com">Google</a>
Javadocs no ofrece ninguna herramienta especial para enlaces externos, por lo que debe usar html estándar:
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.
No use {@link ...}
o {@linkplain ...}
porque estos son para enlaces a los javadocs de otras clases y métodos.
Simplemente use un enlace HTML con un elemento a como
<a href="URL#value">label</a>
Difícil de encontrar una respuesta clara del sitio de Oracle. Lo siguiente es 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>
etiqueta html con el {@link ...}
?
<a>
.
{@link package.class#member label}
@see
etiqueta viene después de los@param
/@return
las etiquetas y antes de los@since
/@serial
/@deprecated
etiquetas.