@default - JsDoc Toolkitを使う！

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

@default

@defaultタグには、クラス内のプロパティメンバのデフォルト値を記述します。

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

構文

@default valueDescription

• valueDescription -- 必須：デフォルト値についての説明

例

/** @constructor */

function Page(title) {

    /**
     * @default "Undefined"
     */

    this.title = title || "Undefined";
}

@defaultタグを関数メンバ（メソッド）に対して記述しても無効です。

関連項目

• @typeタグはオブジェクトのデータ型や関数の戻り値のデータ型を記述するのに使用されます。
  実際のデフォルト値そのものを記述する@defaultタグと比べてみてください。

---