Google Apps Script入門 | 第9回.コメントの書き方 | Google Apps Script(GAS)の入門解説です



最終更新日:2016-09-28

第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列)
これを追加しています。
たったこれだけで、何をしているのかが一目瞭然で分かるようになります。

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


コメントなしのスクリプトと、コメント付きのスクリプト、
どっちが良いかの議論は必用ないでしょう。
ただ、どうしても、コメントを書くのが面倒に感じてしまう事も事実です。
時間をかけてコメントを長々と書く必要はありません。
要所だけを端的に書くことが大切です。




同じテーマ「Google Apps Script入門」の記事

第10回.条件で処理を変える(条件分岐,if)
第11回.条件で処理を変える(条件分岐,switch)
第12回.表範囲をまとめて消去する
第13回.セルに書式を設定する
第14回.複数のシートを扱う
第15回.複数のスプレッドシートを扱う
第16回.Google Apps Scriptの文法

新着記事 ・・・新着記事一覧を見る

メモの挿入・削除と改行文字|Google Apps Script入門(12月6日)
リンクの挿入・編集・削除|Google Apps Script入門(12月6日)
セルに数式を入れる|Google Apps Script入門(12月1日)
セルのコピー&各種ペースト|Google Apps Script入門(11月22日)
Twitter Bot 作成|Google Apps Script応用(11月6日)
Excel流の最終行の取得|Google Apps Script応用(11月6日)
方眼紙Excelが楽に入力できるVBA|ExcelマクロVBAサンプル集(11月5日)
「ポケモンを確実に見つける方法」をExcelで数学してみた|エクセル雑感(11月4日)
スプレッドシート(ブック)の作成・名前変更|Google Apps Script入門(11月4日)
シートの挿入・削除・名前変更|Google Apps Script入門(11月3日)

アクセスランキング ・・・ ランキング一覧を見る

1.最終行の取得(End,Rows.Count)|ExcelマクロVBA入門
2.RangeとCellsの使い方|ExcelマクロVBA入門
3.徹底解説(VLOOKUP,MATCH,INDEX,OFFSET)|エクセル関数超技
4.Range以外の指定方法(Cells,Rows,Columns)|ExcelマクロVBA入門
5.セルの参照範囲を可変にする(OFFSET,COUNTA,MATCH)|エクセル関数超技
6.セルのコピー&値の貼り付け(PasteSpecial)|ExcelマクロVBA入門
7.CSVの読み込み方法|ExcelマクロVBAサンプル集
8.変数とデータ型(Dim)|ExcelマクロVBA入門
9.セル・行・列の削除・挿入(Delete,Insert)|ExcelマクロVBA入門
10.ひらがな⇔カタカナの変換|エクセル基本操作




このサイトがお役に立ちましたら「シェア」「Bookmark」をお願いいたします。


記述には細心の注意をしたつもりですが、
間違いやご指摘がありましたら、「お問い合わせ」からお知らせいただけると幸いです。
なお、掲載のVBAコードは自己責任で使ってください。万一データ破損等の損害が発生しても責任は負いません。



↑ PAGE TOP