@use JSDoc

構文

{@tutorial tutorialID} [リンクテキスト]{@tutorial tutorialID}

概要

インラインタグ{@tutorial}は、指定したチュートリアルIDへのリンクを作成します。{@tutorial}タグを使用すると、いくつかの異なる形式の1つを使用して、リンクテキストも提供できます。リンクテキストを何も提供しない場合、JSDocはチュートリアルのタイトルをリンクテキストとして使用します。

名前パスまたはURLにリンクする必要がある場合は、{@tutorial}タグの代わりに{@link}インラインタグを使用します。

例

次の例は、{@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チュートリアルのタイトルが「はじめに」の場合、上記の例は次のような出力を生成します。

{@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>.