【GAS基礎講座】独自(カスタム)関数の説明をかっこよくする方法(JSDOC)

hiroshi

2年前

GAS基礎講座一覧

ご訪問ありがとうございます。

Googleシートマスターのひろしです。

前回

【GAS基礎講座 5. 】カスタム関数あなた独自の関数がいきなり作れる

GAS(Google Apps Script)であなた独自の関数(カスタム関数)が作成できます。関数のコメント(オートコンプリート)を表示させることができます。

今回は、とっても価値の高い方法をお伝えします。

これを知ることであなたは、

カスタム関数作成時にスプレッドシートから使いやすいドキュメントを作成することができます。
スプレッドシート内の関数の説明と同様のドキュメントを作成できます。

逆に、知らないと

JSDocのフォーマットに従ってカスタム関数のコメントをがんばって記載しているにも関わらず、関数の説明がイマイチの状態のままです。

なので、サクッとマスターして

と答えてあげてください。

動画はこちら

シートはこちら

*クリックすることでシートが開きます。(コピーしてお使いください)

Google スプレッドシートのカスタム関数 | Apps Script | Google for Developers

のカスタム関数をそのまま使用しても
残念ながらスプレッドシート上ではいまいちな説明です。

/**
 * Multiplies an input value by 2.
 * @param {number} input The number to double.
 * @return The input multiplied by 2.
 * @customfunction
*/
function DOUBLE(input) {
  return input * 2;
}

どうやら@paramの{}内の文字列はデータの型ではなく
例を指定するようです。

COUNTIFの説明は以下のとおりです。

これと同じ説明を実現しようとすると。

以下のように記載することで

/**
 * 範囲内で条件に一致する要素の個数を返します。
 * 
 * @param {A1:A10} 範囲 [条件] の検証対象となる範囲です。
 * @param {">20"} 条件 [範囲] に適用するパターンまたはテストです。
 * @customfunction
 */
function TCOUNTIF(範囲,条件){


}

とは言え、関数の引数が日本語なのはイケてないので
全く同じ感じにはできませんが、落とし所としては
以下のような感じでしょうか。

/**
 * 範囲内で条件に一致する要素の個数を返します。
 * 
 * @param {A1:A10} range [条件] の検証対象となる範囲です。
 * @param {">20"} conditions [範囲] に適用するパターンまたはテストです。
 * @customfunction
 */
function TCOUNTIF(range,conditions){


}