{@tutorial}

Содержание

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

Синтаксис

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

Обзор

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

Если вам нужно связаться с именем пути или URL-адресом, используйте тег {@link} вместо тега {@tutorial}.

Примеры

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

/**
 * See {@tutorial gettingstarted} and [Configuring the Dashboard]{@tutorial dashboard}.
 * For more information, see {@tutorial create|Creating a Widget} and
 * {@tutorial destroy Destroying a Widget}.
 */
function myFunction() {}

Если все эти учебники определены, и заголовок учебника gettingstarted — "Начало работы", то пример выше генерирует вывод, аналогичный следующему:

See <a href="tutorial-gettingstarted.html">Getting Started</a> and
<a href="tutorial-dashboard.html">Configuring the Dashboard</a>.
For more information, see <a href="tutorial-create.html">Creating a Widget</a> and
<a href="tutorial-destroy.html">Destroying a Widget</a>.

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

@tutorial