¿Enlace a una URL externa en Javadoc?

3 minutos de lectura

avatar de usuario
destripador234

Algo como:

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

avatar de usuario
aem999

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

  • Si a alguien le interesa, ya que solo tenía que buscarlo: Según el especificación de Javadoc la @see viene la etiqueta después la @param/@return etiquetas y antes de la @since/@serial/@deprecated etiquetas

    – Frieder Bluemle

    11 de octubre de 2013 a las 5:18

  • Por si acaso, Intellij 13 no parece admitir esta etiqueta. Admite enlaces en línea. ¿La etiqueta está de alguna manera en desuso?

    – Timo

    8 de julio de 2014 a las 15:08

  • yo recomiendo <a href="http://google.com" target="_top">http://google.com</a>. La razón para agregar target=”_top” es que algunos de los archivos javadoc html generados usan marcos, y probablemente desee que la navegación afecte a toda la página en lugar de solo al marco actual.

    – Antonio

    30 noviembre 2016 a las 21:31


  • ¿Por qué es tan complicado agregar un enlace URL a un javadoc? quien pensó que HTML era una buena idea… /facepalm

    – Alguien en algún lugar

    8 de enero de 2018 a las 15:26

  • Si alguien más es tan cojo como yo y busca la diferencia entre la versión en línea y la otra durante horas: Cuidado con la ‘@’ antes de ‘Ver’;)

    – István Ori

    9 de marzo de 2018 a las 10:27

avatar de usuario
Aarón

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 carácter.

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

  • Extraño; Juro que solo agregué los acentos graves; No sé a dónde fue el ejemplo…

    – Stobor

    4 de julio de 2009 a las 11:57

  • Creo que tuvimos algún tipo de problema de edición simultánea. Yo también los estaba poniendo.

    – Aarón

    4 de julio de 2009 a las 12:00

  • Me parece bien. Sin embargo, te estás perdiendo los acentos graves en la primera línea de tu cita en bloque…

    – Stobor

    4 de julio de 2009 a las 12:06

  • @see no es necesario. Los javadocs se pueden formatear con etiquetas html, por lo que solo es necesaria la etiqueta “a”.

    – Gabriel Llamas

    23 de abril de 2011 a las 15:31

  • @GabrielLlamas Cierto, pero la pregunta original implica que así es como se usa. Es útil saber que específicamente lo hace trabajar en un campo alternativo, que es donde mucha gente lo querrá.

    – Ionoclasta Brigham

    1 de septiembre de 2015 a las 17:17

Javadocs no ofrece ninguna herramienta especial 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.

avatar de usuario
qiang li

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";

¿Ha sido útil esta solución?

Esta web utiliza cookies propias y de terceros para su correcto funcionamiento y para fines analíticos y para mostrarte publicidad relacionada con sus preferencias en base a un perfil elaborado a partir de tus hábitos de navegación. Al hacer clic en el botón Aceptar, acepta el uso de estas tecnologías y el procesamiento de tus datos para estos propósitos. Configurar y más información
Privacidad