@throws - JsDoc Toolkitを使う！

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

@throws

@throwsタグには、関数（やメソッド）が投げる可能性のある例外について記述します。

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

別名

@exception

構文

@throws {exceptionType} exceptionDescription

• exceptionType -- 省略可：関数が投げる例外のタイプ
• exceptionDescription -- 省略可：例外の説明

例

/**
 * @throws {OutOfMemeory} If the file is too big.
 */

function processFile(path) {
}

---