При документировании кода на Java с помощью Javadoc возникает необходимость добавить ссылку на внешний ресурс, например, веб-страницу. Это может быть полезно, если нужно ссылаться на дополнительные источники информации или на внешние API.
Однако, в Javadoc нет прямой поддержки для создания ссылок на внешние URL. Попытка использовать тег {@link}
с URL приведет к ошибке, так как этот тег предназначен только для создания ссылок на другие элементы в Javadoc.
Вместо этого можно использовать тег {@linkplain}
, который позволяет создать гиперссылку на внешний ресурс.
Пример использования
/** * Дополнительная информация доступна на {@linkplain http://google.com Google}. */
В этом примере {@linkplain http://google.com Google}
создаст гиперссылку на http://google.com с текстом «Google».
Таким образом, для создания ссылки на внешний URL в Javadoc следует использовать тег {@linkplain}
, указывая URL и текст ссылки.
Добавить комментарий