@paramってなんだ

1503 ワード
JSDoc コメント JavaScript JavaScript テキストリンク

＠paramとは

結論から行くと@paramというのはJSDocというツールのタグである

JSDocとは

JavaScript用のソースコードにデコレーターを追加するツール

主なタグ

  • ＠type
    • 変数の型を記述
  • ＠param　
    • 関数の名前、型を記述
  • ＠return
    • 戻り値の型を記述
  • ＠todo
    • 終わっていない課題を記述
  • ＠readonly
    • 読み取り専用を示す

実際の使用例

/**
*テスト変数
* @type {Number}
*/
const test = 10;

/**
*テスト関数
* @param {Number} arg1
* @param {String} arg2
* @return {Boolean}
*/

function test(arg1, arg2) {
  return false
}

参考資料