Antworten:
Dadurch wird eine Überschrift "Siehe auch" erstellt, die den Link enthält, dh:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
wird gerendert als:
Siehe auch:
http://google.com
in der Erwägung, dass dies:
/**
* See <a href="http://google.com">http://google.com</a>
*/
erstellt einen Inline-Link:
Siehe http://google.com
<a href="http://google.com" target="_top">http://google.com</a>.
Der Grund für das Hinzufügen von target = "_ top" liegt darin, dass einige der generierten Javadoc-HTML-Dateien Frames verwenden und Sie wahrscheinlich möchten, dass die Navigation die gesamte Seite und nicht nur den aktuellen Frame betrifft.
Entnommen aus der Javadoc-Spezifikation
@see <a href="URL#value">label</a>
: Fügt einen Link hinzu, wie durch definiert URL#value
. Das URL#value
ist eine relative oder absolute URL. Das Javadoc-Tool unterscheidet dies von anderen Fällen, indem es <
als erstes Zeichen nach einem Symbol ( ) sucht, das kleiner als ist .
Beispielsweise : @see <a href="http://www.google.com">Google</a>
Javadocs bieten keine speziellen Tools für externe Links an, daher 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.
Nicht verwenden {@link ...}
oder {@linkplain ...}
weil diese für Links zu den Javadocs anderer Klassen und Methoden sind.
Verwenden Sie einfach einen HTML-Link mit einem a-Element wie
<a href="URL#value">label</a>
Es ist schwer, eine klare Antwort von der Oracle-Site zu finden. Folgendes 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";
<a>
HTML-Tag mit dem zu versehen {@link ...}
?
<a>
.
{@link package.class#member label}
@see
Tag nach den@param
/@return
-Tags und vor den@since
/@serial
/@deprecated
-Tags.