JavaScript ドキュメンテーションコメント

JavaScript 目次 - ray88’s diary
■ドキュメンテーションコメント
　関数がどのような機能を持っているか、引数や戻り値の内容等
 　コメントとして記述する際の記述法のルールのこと

【ルール】
・関数の宣言の直前に記載する
・「//**」ではじまり「*/」で終わる
・概要と特定のタグを用いた情報で構成される

【ドキュメンテーションコメントで使用するタグ】

タグ	説明	書式
@param	引数の情報を追加する	{データ型}仮引数名・概要
@return	戻り値の情報を追加する	{データ型}-概要
@customfunction	スプレッドシートの補完の候補にする	-	a

■記述例

/**
 * 税込み価格を返す関数
 * @param {Number} price- 価格
 * @param {Number} tax - 税率
 * @return {Number} - 税込み価格
 */

function includeTax(price,taxRate = 0.1) {
  return price * (1 + taxRate);
}

【参考】以下はドキュメンテーションコメントの書き方の参考ページ
Use JSDoc: Index