@tutorial

Содержание

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

Синтаксис

@tutorial 

Обзор

Тег @tutorial вставляет ссылку на файл учебника, предоставляемый в составе документации. Обратитесь к обзору учебников за инструкциями по созданию учебников.

Вы можете использовать тег @tutorial более одного раза в одном комментарии JSDoc.

Примеры

В следующем примере документация для MyClass будет ссылаться на учебники с идентификаторами tutorial-1 и %%%CODE_BLOCK_5%%:

/**
 * Description
 * @class
 * @tutorial tutorial-1
 * @tutorial tutorial-2
 */
function MyClass() {}

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

• Учебники
• {@tutorial}
• @see