@use JSDoc

语法

@tutorial

概述

@tutorial 标记会插入一个指向教程文件的链接,该文件作为文档的一部分提供。有关创建教程的说明,请参阅教程概述

您可以在单个 JSDoc 注释中多次使用 @tutorial 标记。

示例

在以下示例中,MyClass 的文档将链接到具有标识符 tutorial-1tutorial-2 的教程

使用 @tutorial 标记
/**
 * Description
 * @class
 * @tutorial tutorial-1
 * @tutorial tutorial-2
 */
function MyClass() {}