Ссылка на внешний URL-адрес в Javadoc?


что-то типа:

/**
 * See {@linktourl http://google.com}
 */
5 632

5 ответов:

это создает заголовок "See Also", содержащий ссылку, т. е.:

/**
 * @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

взято с документации, спецификаций

@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-элементом, например

<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";