JSDoc中文文档(@use JSDoc)

JSDoc {@tutorial}

目录

语法

{@tutorial tutorialID}
[link text]{@tutorial tutorialID}
{@tutorial tutorialID|link text}
{@tutorial tutorialID link text (after the first space)}

概述

{@tutorial}行内标签创建一个链接到您指定的教程标识符。 当您使用{@tutorial}标签，您也可以提供几种不同的格式的链接文本。 如果你不提供任何链接文本，JSDoc使用本教程的标题作为链接文字。

如果您需要链接到一个namepath或URL， {@link} 内联便签 来代替{@tutorial}标签。

示例

下面的例子显示了提供给{@tutorial}标签链接文本的所有方式，例如：

示例: 提供链接文本
/**
 * See {@tutorial gettingstarted} and [Configuring the Dashboard]{@tutorial dashboard}.
 * For more information, see {@tutorial create|Creating a Widget} and
 * {@tutorial destroy Destroying a Widget}.
 */
function myFunction() {}

如果定义了所有这些教程，并且gettingstarted教程的标题是“Getting Started”,上面的例子输出类似以下内容：

示例: {@link} 标签的输出
See <a href="tutorial-gettingstarted.html">Getting Started</a> and
<a href="tutorial-dashboard.html">Configuring the Dashboard</a>.
For more information, see <a href="tutorial-create.html">Creating a Widget</a> and
<a href="tutorial-destroy.html">Destroying a Widget</a>.

JSDoc @tutorial 标签