Вопрос по java, javadoc – Ссылка на внешний URL в Javadoc?

678

Что-то вроде:

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

Ваш Ответ

5   ответов
1060

см. Также & quot; заголовок, содержащий ссылку, т.е.

/**
 * @see <a href="http://google.com">http://google.com</a>
 */

будет отображаться как:

See Also:
           http://google.com


тогда как это:

/**
 * See <a href="http://google.com">http://google.com</a>
 */

создаст встроенную ссылку:

See http://google.com

На всякий случай Intellij 13, похоже, не поддерживает этот тег. Он поддерживает встроенные ссылки. Является ли тег как-то устаревшим?
Если вы получили предупреждение типа «предупреждение - тег \ @see: отсутствует окончательный»>, убедитесь, что у вас нет двух гиперссылок в одной и той же директиве \ @see. Вместо этого используйте одну ссылку на \ @see.
рекомендую<a href="http://google.com" target="_top">http://google.com</a>.  Причина добавления target = & quot; _top & quot; потому что некоторые из сгенерированных файлов javadoc html используют фреймы, и вы, вероятно, хотите, чтобы навигация влияла на всю страницу, а не только на текущий фрейм.
почему так сложно добавить URL-ссылку на Javadoc? кто думал, что HTML это хорошая идея ... / facepalm
Если кому-то интересно, так как я просто должен был это посмотреть: СогласноJavadoc spec @see тег приходитafter @param/@return теги иbefore @since/@serial/@deprecated теги.
28

ылок, поэтому вы должны просто использовать стандартный 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 других классов и методов.

178

Javadoc Spec

@see <a href="URL#value">label</a> : Adds a link as defined by URL#value,URL#value является относительным или абсолютным URL. Инструмент Javadoc отличает это от других случаев, ища символ меньше чем (<) как первый персонаж.

Например :@see <a href="http://www.google.com">Google</a>

@GabrielLlamas Верно, но оригинальный вопрос подразумевает, как это используется. Полезно знать, что это конкретноdoes работать в поле зрения, где многие люди этого хотят.
@see не нужен. Javadoc могут быть отформатированы с помощью HTML-тегов, так что необходимо только "a" тег.
Weird; Я клянусь, я только добавил в кавычки; Я не знаю, куда пошел этот пример ...
Я думаю, что у нас была какая-то параллельная проблема редактирования. Я вставлял их также.
Справедливо. Вы пропустили галочки в первой строке вашей цитаты, хотя ...
5

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 ...}?
{@Link xxx} здесь не так. {@link xxx} предназначен для ссылки на другие классы и методы в вашем исходном коде. Это не нужно здесь. В остальном это нормально.
Эта конструкция не разрешена стандартами Java 8 (документация включена).
Это, вероятно, ошибка, потому чтоthe javadoc documentation не упоминает эту форму, в ней не имеет значения от необработанных<a>.
Это совершенно неправильно. Правильное использование согласноreference а такжеdocumentation является{@link package.class#member label}
11

<a href="URL#value">label</a>

Просто повторно опубликовал правильный ответ, как он появился из других комментариев. Это будет читать быстрее, чем весь поток.

Похожие вопросы