2009-07-04 21 views

Respuesta

886

Esto crea un "Vea también" la partida 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

+38

Si alguien está interesado, ya que solo tenía que buscarlo: según la [especificación Javadoc] (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#orderoftags) el La etiqueta '@ see' viene * después de * las etiquetas' @ param'/'@ return' y * antes * de las etiquetas' @ since'/'@ serial' /' @ deprecated'. – friederbluemle

+4

Por las dudas, Intellij 13 no parece ser compatible con esta etiqueta. Admite enlaces en línea. ¿De alguna manera la etiqueta está obsoleta? – Timo

+0

Cuando uso esto con Maven, advierte acerca de un símbolo que falta más grande que el final. ¿Alguien sabe por qué? –

167

Tomado del javadoc spec

@see <a href="URL#value">label</a>: añade un enlace 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>

+0

Weird; Juro que solo agregué en los backticks; No sé dónde fue el ejemplo ... – Stobor

+0

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

+0

Bastante justo. Sin embargo, te faltan los backticks en la primera línea de tu blockquot ... – Stobor

8

sólo tiene que utilizar un enlace HTML con un elemento como un

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

+0

Acabo de volver a publicar la respuesta correcta como surgió de los otros comentarios. Esto sería más rápido de leer que todo el hilo. – xamde

2

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

Javadocs no ofrecen ninguna herramienta especial para los enlaces externos, por lo que sólo 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. 

Don' t use {@link ...} o {@linkplain ...} porque estos son para enlaces a los javadocs de otras clases y métodos.

Cuestiones relacionadas