【GAS基本】コードにメモを残す「コメント」の書き方と実践サンプル

プログラムを読みやすく、管理しやすくするために欠かせないのが「コメント（メモ書き）」です。数日後の自分やチームの仲間のために、日本語で説明を残す習慣をつけましょう。

1. コメントの種類と書き方

GAS（JavaScript）では、用途に合わせて2種類の書き方を選べます。

function commentIntro() {
  // ① 単一行コメント：スラッシュ2つでその行の末尾までがメモになります
  const tax = 1.1; // 行の途中から書くことも可能です

  /*
    ② 複数行コメント：
    このように、複数行にわたる長い説明を
    書きたいときに便利です。
  */
}

2. 実践：コメントと console.log の組み合わせ

コメントで「なぜこの処理をするのか」を説明し、console.log で「実際に何が起きているか」を確認するのが開発の基本スタイルです。

function sampleFunction() {
  // 現在の日時を取得して変数に入れる
  const now = new Date();
  
  // 実行ログに現在時刻を表示して、正しく取得できたか確認する
  console.log("現在時刻：" + now);
  
  /*
     ここから下の処理はまだテスト中なので
     実行されないようにコメントアウト（一時停止）しておきます
  */
  // SpreadsheetApp.getUi().alert("こんにちは！");
}

3. コメントを書く時のコツ

• 「なぜ（Why）」を書く： コードを見ればわかること（例：シートを取得する）よりも、目的（例：集計漏れを防ぐために最新シートを指定）を書くと効果的です。
• ショートカットを活用： 行を選択して Ctrl + /（Macは Cmd + /）を押すと、一瞬でコメントのON/OFFを切り替えられます。

コメントは「未来の自分へのメッセージ」です。丁寧にメモを残すクセをつけることで、プログラミングの上達も早まりますよ！