Pregunta ¿Vincular a una URL externa en Javadoc?


Algo como:

/**
 * See {@linktourl http://google.com}
 */

612
2017-07-04 11:44


origen


Respuestas:


Esto crea un encabezado "Ver también" que contiene el enlace, es decir:

/**
 * @see <a href="http://google.com">http://google.com</a>
 */

rendirá 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


961
2018-05-21 10:13



Tomado de la especificaciones javadoc

@see <a href="URL#value">label</a> : Agrega un enlace según lo definido por URL#value. los URL#value es una URL relativa o absoluta. La herramienta Javadoc distingue esto de otros casos al buscar un símbolo menor que (<) como el primer personaje.

Por ejemplo : @see <a href="http://www.google.com">Google</a>


170
2017-07-04 11:50



Javadocs no ofrece herramientas especiales para enlaces externos, por lo que solo 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 usar {@link ...} o {@linkplain ...} porque estos son para enlaces a los javadocs de otras clases y métodos.


25
2017-08-12 20:01



Solo use un enlace HTML con un elemento a como

<a href="URL#value">label</a>


8
2017-11-21 12:20



Es difícil 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";

4
2018-03-11 18:01