JSDoc 中文网

语法

🌐 Syntax

@教程

概述

🌐 Overview

@tutorial 标签插入一个链接，指向作为文档一部分提供的教程文件。
有关创建教程的说明，请参见 教程概览。

🌐 The @tutorial tag inserts a link to a tutorial file that is provided as part of the documentation. See the tutorials overview for instructions on creating tutorials.

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

🌐 You can use the @tutorial tag more than once in a single JSDoc comment.

示例

🌐 Examples

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

🌐 In the following example, the documentation for MyClass will link to the tutorials that have the identifiers tutorial-1 and tutorial-2:

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