2009-07-04 22 views

Antwort

886

Dies schafft ein "Siehe auch" Überschrift mit dem Link, das heißt:

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

machen wird als:

Siehe auch:
                      http://google.com


während dies:

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

wird eine Inline-Link erstellen:

Siehe http://google.com

+38

Wenn jemand interessiert ist, da musste ich nur nachsehen: Laut [Javadoc spec] (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#orderoftags) ist der '@ see' Tag kommt * nach * den' @ param'/'@ return' Tags und * vor * den' @ since'/'@ serial' /' @ deprecated' Tags. – friederbluemle

+4

Nur für den Fall, Intellij 13 scheint dieses Tag nicht zu unterstützen. Es unterstützt Inline-Links. Ist das Tag irgendwie veraltet? – Timo

+0

Wenn ich dies mit Maven verwende, warnt es vor einem fehlenden Finale, das größer ist als das Symbol - wer weiß warum? –

167

vom

javadoc spec Genommen

@see <a href="URL#value">label</a>: Fügt einen Link, wie durch URL#value definiert. Die URL#value ist eine relative oder absolute URL. Das Javadoc-Werkzeug unterscheidet dies von anderen Fällen, indem nach einem Kleiner-als-Zeichen (<) als dem ersten Zeichen gesucht wird.

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

+0

Seltsam; Ich schwöre, ich habe nur die Backticks hinzugefügt; Ich weiß nicht, wohin das Beispiel ging ... – Stobor

+0

Ich denke, wir hatten eine Art von gleichzeitigen Bearbeitungsproblem. Ich habe sie auch reingelegt. – Aaron

+0

Fair genug. Du verpasst aber die Backticks in der ersten Zeile deines Blockausdrucks. – Stobor

8

nur einen HTML-Link mit einem a-Elemente wie

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

+0

Die neue Antwort wurde einfach erneut gepostet, wie sie aus den anderen Kommentaren hervorging. Dies wäre schneller zu lesen als der ganze Thread. – xamde

2

verwenden Fest eine klare Antwort von der Oracle-Website zu finden. Das Folgende ist 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"; 
21

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

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. 

Don‘ t verwenden Sie {@link ...} oder {@linkplain ...}, weil diese Links zu den Javadocs anderer Klassen und Methoden sind.

Verwandte Themen