Quelque chose comme:
/**
* See {@linktourl http://google.com}
*/
Cela crée un en-tête "Voir aussi" contenant le lien, à savoir:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
rendra comme:
Voir aussi:
http://google.com
alors que ceci:
/**
* See <a href="http://google.com">http://google.com</a>
*/
créera un lien en ligne:
Voir http://google.com
Tiré de la spécification javadoc
@see <a href="URL#value">label</a>
: ajoute un lien tel que défini par URL#value
. URL#value
est une URL relative ou absolue. L'outil Javadoc distingue cela des autres cas en recherchant un symbole inférieur à (<
) comme premier caractère.
Par exemple: @see <a href="http://www.google.com">Google</a>
Les Javadocs ne proposent pas d’outils spéciaux pour les liens externes. Vous devez donc utiliser le langage HTML standard:
See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.
ou
@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of
the Martian invasion.
N'utilisez pas {@link ...}
ou {@linkplain ...}
car il s'agit de liens vers les javadocs d'autres classes et méthodes.
Il suffit d'utiliser un lien HTML avec un élément a comme
<a href="URL#value">label</a>
Difficile de trouver une réponse claire sur le site Oracle. Ce qui suit provient 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";