Verknüpfung mit einer externen URL in Javadoc?

Question

Etwa so:

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

Answer 1

Dadurch wird eine "Siehe auch"-Überschrift erstellt, die den Link enthält, d.h.:

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

wird wiedergegeben als:

Siehe auch:
            http://google.com

während dies:

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

wird ein Inline-Link erstellt:

Voir http://google.com

Answer 2

Entnommen aus dem Javadoc-Spezifikation

@see <a href="URL#value">label</a> : Fügt einen Link gemäß der Definition von URL#value . Die URL#value ist eine relative oder absolute URL. Das Javadoc-Tool unterscheidet dies von anderen Fällen, indem es nach einem Weniger-als-Symbol ( < ) als erstes Zeichen.

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

Answer 3

Javadocs bieten keine speziellen Werkzeuge für externe Links, so dass Sie einfach Standard-HTML verwenden sollten:

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.

Verwenden Sie nicht {@link ...} ou {@linkplain ...} weil diese für Links zu den Javadocs anderer Klassen und Methoden gedacht sind.

Answer 4

Es ist schwer, auf der Oracle-Website eine klare Antwort zu finden. Das Folgende ist von 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";