構文

@tutorial

概要

@tutorial タグは、ドキュメントの一部として提供されるチュートリアル ファイルへのリンクを挿入します。チュートリアルの作成方法については、チュートリアルの概要を参照してください。

@tutorial タグは単一の JSDoc コメント内で複数回使用できます。

例

以下の例では、MyClass のドキュメントに、識別子 tutorial-1 と tutorial-2 のあるチュートリアルへのリンクが追加されます

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

関連リンク

• @see
• チュートリアル
• {@tutorial}