Odpowiedzi:
Spowoduje to utworzenie nagłówka „Zobacz także” zawierającego link, tj .:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
będzie renderowane jako:
Zobacz także:
http://google.com
mając na uwadze, że:
/**
* See <a href="http://google.com">http://google.com</a>
*/
utworzy link w linii:
Zobacz http://google.com
<a href="http://google.com" target="_top">http://google.com</a>.
Powodem dodania target = "_ top" jest to, że niektóre z wygenerowanych plików HTML javadoc korzystają z ramek i prawdopodobnie chcesz, aby nawigacja wpływała na całą stronę, a nie tylko na bieżącą ramkę.
Zaczerpnięte ze specyfikacji javadoc
@see <a href="URL#value">label</a>
: Dodaje link zgodnie z definicją URL#value
. URL#value
Względny lub bezwzględny adres URL. Narzędzie Javadoc odróżnia to od innych przypadków, szukając mniej niż symbolu ( <
) jako pierwszego znaku.
Na przykład : @see <a href="http://www.google.com">Google</a>
Javadocs nie oferuje żadnych specjalnych narzędzi do zewnętrznych linków, więc powinieneś po prostu użyć standardowego HTML:
See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.
lub
@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of
the Martian invasion.
Nie używaj {@link ...}
lub {@linkplain ...}
ponieważ są to linki do javadoców innych klas i metod.
Wystarczy użyć linku HTML z takim elementem jak
<a href="URL#value">label</a>
Trudno znaleźć jasną odpowiedź ze strony Oracle. Poniższe pochodzi z 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>
tagu html {@link ...}
?
<a>
.
{@link package.class#member label}
@see
tag przychodzi po w@param
/@return
tagów i zanim się@since
/@serial
/@deprecated
tagami.