GAS 一括コメントアウトのショートカット

GAS 一括コメントアウトのショートカット

GAS(Google Apps Script)でコメントアウトする場合は、「//」や「/* */」を使用します。

また、Google Apps Scriptエディタには一括コメントアウト用のショートカットが用意されており、複数行をまとめてコメントアウトすることも可能です。

コメントアウトは、プログラムの動作確認やデバッグ、一時的に処理を無効化したい場合によく利用されます。

この記事では、GASでコメントアウトする方法、一括コメントアウトのショートカット、複数行コメントの書き方について解説します。

環境

  • OS windows11 home
  • ブラウザ chrome 106.0.5249.103

ショートカット

一括でコメントアウトするには、「Ctrl + /」で可能です。
※macの場合は「command + /」となります。

【windows】

Ctrl + /

【mac】

command + /

実行すると、選択した範囲が一括でコメントアウトされていることが確認できます。

1行だけコメントアウトする

GASで1行だけコメントアウトする場合は、「//」を使用します。

function test() {

  // Logger.log('test');

}

「//」以降は実行されなくなります。

処理を一時的に無効化したい場合に便利です。

複数行をコメントアウトする

複数行をコメントアウトする場合は、「/* */」を使用できます。

function test() {

  /*
  Logger.log('test1');
  Logger.log('test2');
  Logger.log('test3');
  */

}

「/」から「/」までの範囲がコメントとして扱われます。

関数の説明にはJSDocを使用する

Google Apps Scriptでは、関数説明にJSDoc形式を使用することもできます。

/**
 * シートのデータを取得する
 * @return {Array}
 */
function getData() {

}

関数の役割や戻り値を明確にできます。

用するのがおすすめです。

まとめ

GASでコメントアウトする方法は以下の通りです。

// 1行コメント

/*
複数行コメント
*/

ショートカットを使用する場合は以下になります。

Windows : Ctrl + /
Mac     : Command + /

Google Apps Scriptでデバッグや動作確認を行う場合は、コメントアウトを活用すると効率的に開発できます。