@example - JsDoc Toolkitを使う！

トップページ > ドックコメントの書き方 > タグリファレンス >

@example

@exampleタグには、コンストラクタ、関数（またはメソッド）、変数の使い方を解説する小さなコードを記述できます。

• http://code.google.com/p/jsdoc-toolkit/wiki/TagExample

構文

@example snippet

• snippet -- 必須：使用法を解説するごく小さいコード
• @exampleタグは複数記述できます。

例

/**
 * @example
 * var bleeper = makeBleep(3);
 * bleeper.flop();
 */

注意

@exampleタグではサンプルコードを説明文中へ「インライン」に挿入することは想定されていません。その場合は（例えば<code>タグなどの）HTMLタグを使用する必要があります。

---