{@link}

Содержание

• Синонимы
• Синтаксис
• Обзор
• Форматирование ссылок
• Примеры
• Связанные ссылки

Синонимы

• {@linkcode}
• {@linkplain}

Синтаксис

{@link namepathOrURL}
[link text]{@link namepathOrURL}
{@link namepathOrURL|link text}
{@link namepathOrURL link text (after the first space)}

Обзор

Тег {@link} инлайн создает ссылку на указанный вами namepath или URL. Когда вы используете тег {@link}, вы также можете указать текст ссылки, используя один из нескольких различных форматов. Если вы не укажете текст ссылки, JSDoc использует namepath или URL в качестве текста ссылки.

Если вам нужно создать ссылку на учебник, используйте тег {@tutorial} инлайн вместо тега {@link}.

Форматирование ссылок

По умолчанию, {@link} генерирует стандартные HTML-теги якоря. Однако, вам может быть предпочтительнее отображать определённые ссылки моноширинным шрифтом или задавать формат отдельных ссылок. Вы можете использовать следующие синонимы для тега {@link} для управления форматом ссылок:

• {@linkcode}: Принудительно использует моноширинный шрифт для текста ссылки.
• {@linkplain}: Принудительно отображает текст ссылки как обычный текст без моноширинного шрифта.

Вы также можете установить один из следующих параметров в файле конфигурации JSDoc; см. Настройка JSDoc для получения более подробной информации:

• templates.cleverLinks: Когда установлено значение true, ссылки на URL используют обычный текст, а ссылки на код — моноширинный шрифт.
• templates.monospaceLinks: Когда установлено значение true, все ссылки используют моноширинный шрифт, за исключением ссылок, созданных с помощью тега {@linkplain}.

Примечание: Хотя шаблон JSDoc по умолчанию корректно отображает все эти теги, другие шаблоны могут не распознавать теги {@linkcode} и {@linkplain}. Кроме того, другие шаблоны могут игнорировать параметры конфигурации для отображения ссылок.

Примеры

Следующий пример демонстрирует все способы указания текста ссылки для тега {@link}.

/**
 * See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}.
 * Also, check out {@link http://www.google.com|Google} and
 * {@link https://github.com GitHub}.
 */
function myFunction() {}

По умолчанию, пример выше генерирует вывод, похожий на следующий:

See <a href="MyClass.html">MyClass</a> and <a href="MyClass.html#foo">MyClass's foo
property</a>. Also, check out <a href="http://www.google.com">Google</a> and
<a href="https://github.com">GitHub</a>.

Если свойство конфигурации templates.cleverLinks было установлено в значение true, пример выше выведет следующий результат:

See <a href="MyClass.html"><code>MyClass</code></a> and <a href="MyClass.html#foo">
<code>MyClass's foo property</code></a>. Also, check out
<a href="http://www.google.com">Google</a> and <a href="https://github.com">GitHub</a>.

Связанные ссылки

• Настройка JSDoc с помощью файла конфигурации
• Использование namepaths с JSDoc 3