wake-up-neo.com

Verlinkung mit einer externen URL in Javadoc?

So etwas wie:

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

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

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

wird gerendert als:

Siehe auch:
http://google.com


während dies:

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

erstellt einen Inline-Link:

Siehe http://google.com

1132
aem999

Entnommen aus der javadoc spec

@see <a href="URL#value">label</a>: Fügt einen durch URL#value definierten Link hinzu. Der URL#value ist eine relative oder absolute URL. Das Javadoc-Tool unterscheidet sich von anderen Fällen dadurch, dass als erstes Zeichen ein kleineres Symbol (<) gesucht wird.

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

182
Aaron

Da Javadocs keine speziellen Tools für externe Links anbieten, sollten Sie nur Standard-HTML verwenden:

See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.

oder

@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of 
the Martian invasion.

Verwenden Sie nicht {@link ...} oder {@linkplain ...}, da dies Links zu den Javadocs anderer Klassen und Methoden sind.

31
Orlando DFree

Verwenden Sie einfach einen HTML-Link mit einem a-Element wie

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

11
Dr. Max Völkel

Es ist schwer, eine klare Antwort von der Oracle-Site zu finden. Folgendes stammt aus 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";
5
Qiang Li