Etwas wie:
/**
* See {@linktourl http://google.com}
*/
Verlinkung zu einer externen URL in Javadoc?
Lesezeit: 3 Minuten
13617900cookie-checkVerlinkung zu einer externen URL in Javadoc?
Reißer234
aem999
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 gerendert als:
Siehe auch:
während dies:
/**
* See <a href="http://google.com">http://google.com</a>
*/
erstellt einen Inline-Link:
Sehen http://google.com
-
Falls es jemanden interessiert, da musste ich gerade mal nachschauen: Laut der Javadoc-Spezifikation das
@seeEtikett kommt nach das@param/@returnTags und Vor das@since/@serial/@deprecatedStichworte.– friederblümle
11. Oktober 2013 um 5:18 Uhr
-
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
8. Juli 2014 um 15:08 Uhr
-
Ich empfehle
<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.– Antonius
30. November 2016 um 21:31 Uhr
-
Warum ist es so kompliziert, einen URL-Link zu einem Javadoc hinzuzufügen? wer dachte, dass HTML eine gute Idee wäre… /facepalm
– Irgendwer irgendwo
8. Januar 2018 um 15:26 Uhr
-
Falls noch jemand so lahm ist wie ich und stundenlang nach dem Unterschied zwischen der Inline-Version und der anderen sucht: Achtet auf das ‘@’ vor ‘See’ 😉
– István Őri
9. März 2018 um 10:27 Uhr
Aaron
Entnommen aus der javadoc spec
@see <a href="URL#value">label</a> : Fügt einen Link wie definiert durch hinzu URL#value. Das URL#value ist eine relative oder absolute URL. Das Javadoc-Tool unterscheidet dies von anderen Fällen, indem es nach einem Kleiner-als-Symbol sucht (<) als erstes Zeichen.
Zum Beispiel : @see <a href="http://www.google.com">Google</a>
-
Seltsam; Ich schwöre, ich habe nur die Backticks hinzugefügt; Ich weiß nicht, wo das Beispiel geblieben ist …
– Stobor
4. Juli 2009 um 11:57 Uhr
-
Ich glaube, wir hatten ein Problem mit der gleichzeitigen Bearbeitung. Ich habe sie auch eingebaut.
– Aaron
4. Juli 2009 um 12:00 Uhr
-
Fair genug. Sie vermissen jedoch die Backticks in der ersten Zeile Ihres Blockquotes ….
– Stobor
4. Juli 2009 um 12:06 Uhr
-
@see wird nicht benötigt. Die Javadocs können mit HTML-Tags formatiert werden, daher ist nur das “a”-Tag erforderlich.
– Gabriel Lamas
23. April 2011 um 15:31 Uhr
-
@GabrielLlamas Stimmt, aber die ursprüngliche Frage impliziert, dass es so verwendet wird. Es ist nützlich zu wissen, dass es spezifisch ist tut in einem Siehe-auch-Bereich arbeiten, wo viele Leute es wollen werden.
– Ionoklast Brigham
1. September 2015 um 17:17 Uhr
Javadocs bieten keine speziellen Tools für externe Links, daher sollten Sie einfach 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 Links zu den Javadocs anderer Klassen und Methoden sind.
Qiang Li
Es ist schwierig, eine klare Antwort auf der Oracle-Website 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";
