跳到主要内容

@tutorial

语法

@tutorial <tutorialID>

概述

@tutorial 标签插入一个指向向导教程的链接,作为文档的一部分。有关创建教程指导请参阅 tutorials overview

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

实例

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

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

相关链接