@returns - JsDoc Toolkitを使う！

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

@returns

@returnsタグには、関数またはメソッドの戻り値を記述します。

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

別名

@return

構文

@returns {returnType} returnDescription

• returnType -- 省略可：戻り値のデータ型
• returnDescription -- 省略可：戻り値の説明
• @returnsタグは複数記述が可能です。

例

/**
 * @returns {Array} Lines from the file.
 */

function readLines(filepath) {
}

---