GAS入門講座第4回｜コメントを書いてコードを読みやすくしよう

第3回では、Logger.log を使って、処理の途中経過や変数の中身を実行ログで確認する方法を整理しました。コードの動きを目で見える形にすることは、GASの学習やデバッグでとても大切です。

第4回では、コメントの書き方 と 後から見返しても読みやすいコードの作り方 を解説します。コメントをうまく活用すると、数日後や数か月後にコードを見直したときや、他の人にコードを共有するときにスムーズに内容を理解できるようになります。

第4回のゴール

今回のゴールは、GASコード内に適切なコメントを書き、あとから読んでも何をしている処理かが一目でわかる状態を作れるようになることです。

1行コメント（//） と 複数行コメント（/* */） の使い分けができる
何をしている処理かを短い言葉でメモを残せる
不要なコメントを減らし、コードを読みやすく保つコツがわかる

コメントとは

コメントとは、コードの中に書く「プログラムとしては実行されない説明文（メモ）」のことです。GAS（JavaScript）では、特定の記号を使ってコメントを指定します。

コメントとして書かれた部分は、プログラムの実行時に無視されます。そのため、計算やセル操作などの動作に影響を与えることなく、コードの意味や注意点をメモとして残すことができます。

今回使うサンプルコード

今回は、スプレッドシートのA1セルに見出しを入れ、A2セルに説明文を書き込む処理にコメントを添えたサンプルコードを使います。

function commentPractice() {
  // アクティブなシートを取得
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

  // A1セルに見出しを入れる
  sheet.getRange("A1").setValue("今日の練習");

  // A2セルに説明文を入れる
  sheet.getRange("A2").setValue("コメントを書く練習です");

  /*
   * 複数行のメモを書く例：
   * この関数はスプレッドシートの練習用セル初期化を行います。
   */
}

このコードを実行しても、コメント部分（// や /* ... */）は無視され、A1セルとA2セルへの書き込み処理のみが実行されます。

実行手順

Googleスプレッドシートを開きます。
メニューから「拡張機能」→「Apps Script」を開きます。
エディタにサンプルコードを貼り付けます。
保存します（Ctrl + S または Cmd + S）。
関数名で commentPractice を選択します。
「実行」ボタンを押します。
スプレッドシートのA1セルに「今日の練習」、A2セルに「コメントを書く練習です」が入ったことを確認します。

コメントの書き方（2つの記号）

GAS（JavaScript）でコメントを書く方法は主に2通りあります。

書き方	記号	使いどころ
1行コメント	`// メモ`	行の補足や直後の処理の簡単な説明
複数行コメント	`/* メモ */`	関数の概要や複数行にわたる長めの説明

1行コメントは // の右側がすべてコメント扱いになります。コードの行末につけることも可能です。

const message = "Hello"; // 変数に文字列を代入

コードを読みやすくするコメントのコツ

コメントはたくさん書けばよいというわけではありません。当たり前のことをすべてコメントにすると、かえってコードが読みづらくなってしまいます。

「何をしているか」ではなく「なぜそうしているか（目的）」を書く
当たり前すぎる処理にはコメントを書かない（例：const a = 1; // aに1を入れる は不要）
処理の「カタマリ（ブロック）」ごとに見出しコメントを入れる

「自分以外の人が見たとき」「1か月後の自分が見たとき」に理解しやすいかを意識してコメントを残すのがコツです。

一時的にコードを休ませる「コメントアウト」

コメントのもう一つの便利な使い方が コメントアウト です。コードの一部を消さずに一時的に無効化したいとき、先頭に // をつけることで実行対象から外すことができます。

// sheet.getRange("A2").setValue("一時的に止めたい処理");

動作チェック中や、テストで特定の処理だけを試したいときにとても役に立ちます。

初心者がよくつまずくポイント

閉じ忘れ：/* で始めたのに */ を忘れると、それ以降のコードがすべてコメント扱いになり動かなくなる
コメントに全角スラッシュを使ってしまう：／／ や ／＊ はエラーになるため、必ず半角英数（//, /* */）で書く
コメントを書きすぎてコードが埋もれる：要点にしぼってすっきり書くことを意識する

小さな練習

理解を深めるために、次の練習を行ってみましょう。

A3セルに「コメント練習完了」と書き込む処理を追加し、直前に1行コメントを書く
A2セルの書き込み処理を // でコメントアウトして実行し、A2セルが更新されないことを確認する
関数の先頭に /* ... */ を使って、自分の名前と日付のメモを残してみる

まとめ

今回は、GAS入門講座の第4回として、コメントの書き方と読みやすいコードを作る基礎を学びました。

コメントを活用することで、コードの目的が明確になり、後からの見直しやエラー探しの効率が格段に上がります。//（1行）と /* */（複数行）をうまく使い分けていきましょう。

次回は、「constとletでデータを一時的に覚えよう」（変数の基礎）を解説します。

GAS入門講座 第4回｜コメントを書いてコードを読みやすくしよう