コメントの書き方｜Google Apps Script入門

公開日：2016-09-28　最終更新日：2021-03-05

第9回.コメントの書き方

Google Apps Scriptはプログラミング言語です。

基本は英文ですが、英文そのものではなく、
単語の組み合わせ、単語の省略形、記号等で出来ています。

適宜コメントを書いて、わかり易くしておくことはとても重要です。

スクリプトの実行に関係のないコメントの事を、コメントアウトと言います。

コメントアウトの書き方

行頭および行の途中に、
//
を書くと、それ以降がコメントアウトされます。

/*から*/の間は、コメントアウトされます。
行の途中でこれを使う意味はないので、
通常は、複数行をまとめてコメントアウトする時に使います。
/*
この間は何行でも全てコメントアウトになります。
*/

コメントアウトは、他と見分けがつきやすいように色分けされて表示されます。

コメントの必要性

スクリプトにコメントを書くことで、
後で見たとき、他人が見たときに、分かりやすくしておきます。

function mySample5() {
  var sheet = SpreadsheetApp.getActiveSheet()
  var tannka,suuryou,lastRow
  lastRow = sheet.getLastRow()
  for (i=2; i<=lastRow; i++) {
    tannka = sheet.getRange(i, 2).getValue()
    suuryou = sheet.getRange(i, 3).getValue()
    sheet.getRange(i, 4).setValue(tannka * suuryou) 
  }
}

前回書いたスクリプトですが、
これだけ見たのでは、何をやっているか全くわかりません。
スプレッドシートと見比べて、初めて処理内容が理解できます。

function mySample5() {
  var sheet = SpreadsheetApp.getActiveSheet()
  var tannka,suuryou,lastRow
  lastRow = sheet.getLastRow()
  for (i=2; i<=lastRow; i++) {
    // 金額（D列） = 単価（B列） × 数量（C列）
    tannka = sheet.getRange(i, 2).getValue()
    suuryou = sheet.getRange(i, 3).getValue()
    sheet.getRange(i, 4).setValue(tannka * suuryou) 
  }
}

// 金額（D列） = 単価（B列） × 数量（C列）
これを追加しています。
たったこれだけで、何をしているのかが一目瞭然で分かるようになります。

半年後、一年後に、スクリプトを見直したときコメントのありがたさが実感できるでしょう。
また、他人とスクリプトを共有する場合は特に、このコメントが役に立ちます。