Что-то вроде:
/**
* See {@linktourl http://google.com}
*/
Что-то вроде:
/**
* See {@linktourl http://google.com}
*/
Это создает заголовок "См. также", содержащий ссылку, т.е.:
/**
* @see <a href="http://google.com">http://google.com</a>
*/
отобразит как:
См. также:
а это:
/**
* See <a href="http://google.com">http://google.com</a>
*/
создаст ссылку в строке:
Взято из javadoc spec
@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 Mill</a> for a history of the
Martian invasion.
или
@see <a href="http://groversmill.com/">Grover Mill</a> for a history of
the Martian invasion.
Не используйте {@link ...}
или {@linkplain ...}
, потому что они предназначены для ссылок на javadocs других классов и методов.
Просто используйте ссылку HTML с помощью элемента a, например
<a href="URL#value">label</a>
Трудно найти четкий ответ с сайта Oracle. Ниже приведено значение javax.ws.rs.core.HttpHeaders.java
:
/**
* See {@link <a href="#" onclick="location.href='http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1'; return false;">HTTP/1.1 documentation</a>}.
*/
public static final String ACCEPT = "Accept";
/**
* See {@link <a href="#" onclick="location.href='http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2'; return false;">HTTP/1.1 documentation</a>}.
*/
public static final String ACCEPT_CHARSET = "Accept-Charset";