Посилання на зовнішню URL-адресу в Javadoc?


Відповіді:


1223

Це створює заголовок "Дивіться також", що містить посилання, тобто:

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


59
Якщо кому - то цікаво, так як я просто повинен був подивитися його: Згідно Javadoc специфікації@see бирки приходить після того, як в @param/ @returnтегах і до того в @since/ @serial/ @deprecatedтегах.
friederbluemle

7
Про всяк випадок, схоже, Intellij 13 не підтримує цей тег. Він підтримує поточні посилання. Чи тег якось застарілий?
Тимо

24
Я рекомендую <a href="http://google.com" target="_top">http://google.com</a>. . Причина додавання target = "_ top" полягає в тому, що деякі з генерованих файлів html-файлів javadoc використовують кадри, і ви, мабуть, хочете, щоб навігація впливала на всю сторінку, а не лише на поточний кадр.
Антоній

3
Якщо ви отримаєте попередження на кшталт "попередження - тег \ @see: відсутній остаточний '>':", переконайтеся, що у вас немає двох гіперпосилань у тій же \ @показанні. Замість цього скористайтеся одним посиланням на \ @побачте.
Травіс Спенсер

7
чому так складно додати URL-посилання на javadoc? хто подумав, що HTML - це гарна ідея ... / facepalm
Хтось десь

189

Взято з специфікації javadoc

@see <a href="URL#value">label</a>: Додає посилання, як визначено URL#value. URL#valueЄ відносним або абсолютним URL - адреса. Інструмент Javadoc відрізняє це від інших випадків, шукаючи символ, що не перевищує символ ( <), як перший символ.

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


Дивний; Клянусь, що я додав лише в задній план; Я не знаю, куди
подівся

Думаю, у нас була якась проблема одночасного редагування. Я також їх вкладав.
Аарон

Справедливо. Однак у першому рядку
блокувальної котировки

27
@see не потрібен. Формати javadocs можуть бути відформатовані html-тегами, тому потрібен лише тег "a".
Габріель Лламас

5
@GabrielLlamas Щоправда, але оригінальне питання передбачає, як це використовується. Це корисно знати , що конкретно робить роботу в см-поле також, що , коли багато людей хочуть.
Іонокласт Брігхем

33

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 інших класів та методів.


16

Просто використовуйте HTML-посилання з таким елементом, як

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


Просто повторно розмістив правильну відповідь, як це з’явилося з інших коментарів. Це було б швидше прочитати, ніж ціла нитка.
доктор Макс Вьолкель

4

Важко знайти чітку відповідь з сайту 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 ...}?
Патрік М

2
Це, мабуть, помилка, тому що в документації на javadoc ця форма не згадується, в ній вона не відрізняється від сировини <a>.
Дідьє Л

4
{@Link xxx} тут неправильно. {@link xxx} призначений для посилання на інші класи та методи у вихідному коді. Тут непотрібно. Решта - це добре.
MiguelMunoz

4
Ця конструкція заборонена стандартами Java 8 (doclint on).
Степан Вавра

1
Це явно неправильно. Правильне використання в якості одного посилань і документації є{@link package.class#member label}
Dinei
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.