java - significa - los atributos alt
¿Enlace a una URL externa en Javadoc? (5)
Algo como:
/**
* See {@linktourl http://google.com}
*/
Es difícil encontrar una respuesta clara desde 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";
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:
Javadocs no ofrece 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 los javadocs de otras clases y métodos.
Solo usa un enlace HTML con un a-elemento como
<a href="URL#value">label</a>
Tomado de la especificación de javadoc
@see <a href="URL#value">label</a>
: agrega un enlace como se define por URL#value
. El URL#value
es una URL relativa o absoluta. La herramienta Javadoc distingue esto de otros casos buscando un símbolo menos que ( <
) como el primer carácter.
Por ejemplo: @see <a href="http://www.google.com">Google</a>