Відповіді:
Це створює заголовок "Дивіться також", що містить посилання, тобто:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
відображатиметься як:
Дивіться також:
http://google.com
враховуючи це:
/**
* See <a href="http://google.com">http://google.com</a>
*/
створить внутрішнє посилання:
Дивіться сторінку http://google.com
<a href="http://google.com" target="_top">http://google.com</a>.
. Причина додавання target = "_ top" полягає в тому, що деякі з генерованих файлів html-файлів javadoc використовують кадри, і ви, мабуть, хочете, щоб навігація впливала на всю сторінку, а не лише на поточний кадр.
Взято з специфікації javadoc
@see <a href="URL#value">label</a>
: Додає посилання, як визначено URL#value
. URL#value
Є відносним або абсолютним URL - адреса. Інструмент Javadoc відрізняє це від інших випадків, шукаючи символ, що не перевищує символ ( <
), як перший символ.
Наприклад : @see <a href="http://www.google.com">Google</a>
Javadocs не пропонують жодних спеціальних інструментів для зовнішніх посилань, тому вам слід просто використовувати стандартний html:
See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.
або
@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of
the Martian invasion.
Не використовуйте {@link ...}
або {@linkplain ...}
тому, що вони призначені для посилань на javadocs інших класів та методів.
Просто використовуйте HTML-посилання з таким елементом, як
<a href="URL#value">label</a>
Важко знайти чітку відповідь з сайту Oracle. Далі від 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>
html-тегу з {@link ...}
?
<a>
.
{@link package.class#member label}
@see
бирки приходить після того, як в@param
/@return
тегах і до того в@since
/@serial
/@deprecated
тегах.