Coś jak:
/**
* See {@linktourl http://google.com}
*/
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
@see
tag przychodzi po w@param
/@return
tagów i zanim się@since
/@serial
/@deprecated
tagami.<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>
źródło
Javadocs nie oferuje żadnych specjalnych narzędzi do zewnętrznych linków, więc powinieneś po prostu użyć standardowego HTML:
lub
Nie używaj
{@link ...}
lub{@linkplain ...}
ponieważ są to linki do javadoców innych klas i metod.źródło
Wystarczy użyć linku HTML z takim elementem jak
<a href="URL#value">label</a>
źródło
Trudno znaleźć jasną odpowiedź ze strony Oracle. Poniższe pochodzi z
javax.ws.rs.core.HttpHeaders.java
:źródło
<a>
tagu html{@link ...}
?<a>
.{@link package.class#member label}