Antwort
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
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>
Seltsam; Ich schwöre, ich habe nur die Backticks hinzugefügt; Ich weiß nicht, wohin das Beispiel ging ... – Stobor
Ich denke, wir hatten eine Art von gleichzeitigen Bearbeitungsproblem. Ich habe sie auch reingelegt. – Aaron
Fair genug. Du verpasst aber die Backticks in der ersten Zeile deines Blockausdrucks. – Stobor
nur einen HTML-Link mit einem a-Elemente wie
<a href="URL#value">label</a>
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
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";
Welche Bedeutung hat das Umschließen des '' html Tags mit dem '{@link ...}'? –
Das ist wahrscheinlich ein Fehler, weil [die javadoc-Dokumentation] (http://docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#@link) dieses Formular darin nicht erwähnt macht keinen Unterschied zu einem rohen ''. –
Der {@link xxx} ist hier nicht richtig. {@link xxx} dient zum Verknüpfen mit anderen Klassen und Methoden in Ihrem Quellcode. Es ist unnötig hier. Der Rest ist in Ordnung. – MiguelMunoz
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.
- 1. Erstellen einer externen URL in Schienen
- 2. Umleiten zu externen URL in ember.js Controller
- 3. UITableViewCell Verlinkung zu einer bestimmten Seite in PageViewController
- 4. Capybara/Poltergeist Umleiten zu einer externen URL (nicht holen)
- 5. Link zu einer externen URL mit LinkTo mit HandelBars
- 6. So öffnen Sie angeschlossene Javadoc in externen Browser
- 7. Erhalten Bildgröße beim Laden von einer externen URL in Javascript
- 8. Anfügen einer Klasse von externen URL in jquery
- 9. Verlinkung mit libpng & zlib?
- 10. Tornado: URL in externen CSS-Datei
- 11. Laravel zur externen URL gehen?
- 12. TFS Verlinkung von Backlog-Elementen
- 13. Javadoc für javadoc com.install4j.runtime.beans.formcomponents.DirectoryChooserComponent
- 14. Wie erhalte ich JSON-Daten von einer externen URL?
- 15. Herunterladen eines Bilds von einer externen URL mit cURL
- 16. react-router navigiere zur externen URL
- 17. HandlesJs.Net Verlinkung Style Sheets/CSS
- 18. Get File von externen URL mit fs.readFile
- 19. Subdomain-Zuordnung zu einer anderen externen Subdomäne
- 20. browserCaps in einer externen Konfigurationsdatei
- 21. Javadoc Link zu Verfahren in anderer Klasse
- 22. recaptcha mit externen Formular verwenden senden URL
- 23. Definieren der externen URL für Url.Content()
- 24. Verlinkung zur Liste der Blogposts mit Wordpress?
- 25. Verwendung der externen URL in ng-include in AngularJS
- 26. Umleitung genaue URL zu einer anderen URL
- 27. Javadoc in Junit Testklassen?
- 28. Verlinkung von libC++ zu CMake-Projekt unter Linux
- 29. JavaDoc in Eclipse suchen
- 30. Verwenden von Gcc auf Win32 und Verlinkung zu msvcrt.dll
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
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
Wenn ich dies mit Maven verwende, warnt es vor einem fehlenden Finale, das größer ist als das Symbol - wer weiß warum? –