¿Vincular a una URL externa en Javadoc?
Esto crea un encabezado "Ver también" que contiene el enlace, es decir:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
se representará 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:
Ver http://google.com
Tomado de la especificación javadoc
@see <a href="URL#value">label</a>: Agrega un enlace definido por URL#value. Es URL#valueuna URL relativa o absoluta. La herramienta Javadoc distingue este de otros casos buscando un símbolo menor que ( <) como primer carácter.
Por ejemplo :@see <a href="http://www.google.com">Google</a>
Los Javadocs no ofrecen ninguna herramienta especial para enlaces externos, por lo que solo debes 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 son para enlaces a javadocs de otras clases y métodos.
Es difícil encontrar una respuesta clara en el 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";
