@см

Содержание

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

Синтаксис

• @see <namepath>
• @see <text>

Обзор

Тег @см позволяет ссылаться на другой символ или ресурс, который может быть связан с документируемым. Вы можете указать имя символа или свободный текст. Если вы укажете имя символа, по умолчанию шаблон JSDoc автоматически преобразует имя в ссылку.

Примеры

/**
 * Both of these will link to the bar function.
 * @see {@link bar}
 * @see bar
 */
function foo() {}

// Use the inline {@link} tag to include a link within a free-form description.
/**
 * @see {@link foo} for further information.
 * @see {@link http://github.com|GitHub}
 */
function bar() {}

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

{@ссылка}