@deprecated - JsDoc Toolkitを使う！

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

@deprecated

@deprecatedタグは、このクラス、メソッド、プロパティを現在は使用すべきでないことを示します。

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

構文

@deprecated deprecatedDescription

• deprecatedDescription -- 必須：非推奨な状態にある項目についての情報（非推奨となったバージョンや、この項目に取って代わった新しい項目など）を記述します。
• @deprecatedタグは複数記述することができます。

例

/**
 * @deprecated Since version 0.5. You should now use NewFoo.
 */

function Foo() {
}

---