@tutorial
描述: 插入一个链接到包含教程文件。
语法
@tutorial <tutorialID>
概述
@tutorial
标签插入一个指向向导教程的链接,作为文档的一部分。有关创建教程指导请参阅tutorials overview。
在一个JSDoc注释块中您可以包含多个@tutorial
标签。
例子
在下面的例子中,MyClass
的文档将链接到tutorial-1
和 tutorial-2
标识符的教程。
例如,使用 @tutorial 标签:
/** * Description * @class * @tutorial tutorial-1 * @tutorial tutorial-2 */ function MyClass() {}