Google Apps Script入門
第9回.コメントの書き方

Google Apps Script(GAS)の入門解説です
最終更新日:2016-09-28

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

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


基本は英文ですが、英文そのものではなく、

単語の組み合わせ、単語の省略形、記号等で出来ています、

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


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

コメントアウトの書き方

行頭および行の途中に、

//
を書くと、それ以降がコメントアウトされます。

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

GAS 参考画像

このように、他と見分けがつきやすいように色分けされて表示されます。


コメントの必要性

スクリプトにコメントを書くことで、

後で見たとき、他人が見たときに、分かりやすくしておきます。
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入門」の記事

第6回.セルの値を使って計算する
第7回.同じ計算を行数分繰り返す
第8回.最終行を取得して繰り返す
第9回.コメントの書き方
第10回.条件で処理を変える(条件分岐,if)
第11回.条件で処理を変える(条件分岐,switch)
第12回.表範囲をまとめて消去する
第13回.セルに書式を設定する
第14回.複数のシートを扱う
第15回.複数のスプレッドシートを扱う
第16回.Google Apps Scriptの文法


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

Variantの数値型と文字列型の比較|エクセル雑感(7月1日)
VBAのVariant型について|VBA技術解説(6月30日)
VBAのString型の最大文字数について|エクセル雑感(6月20日)
VBAで表やグラフをPowerPointへ貼り付ける|VBAサンプル集(6月19日)
アクティブシート以外の表示(Window)に関する設定|VBA技術解説(6月17日)
マクロ記録での色のマイナス数値について|エクセル雑感(6月16日)
ツイッター投稿用に文字数と特定文字で区切る|エクセル雑感(6月15日)
日付の謎:IsDateとCDate|エクセル雑感(6月14日)
IFステートメントの判定|エクセル雑感(6月13日)
インクリメンタルサーチの実装|ユーザーフォーム入門(6月12日)


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

1.最終行の取得(End,Rows.Count)|VBA入門
2.RangeとCellsの使い方|VBA入門
3.変数宣言のDimとデータ型|VBA入門
4.マクロって何?VBAって何?|VBA入門
5.セルのコピー&値の貼り付け(PasteSpecial)|VBA入門
6.Range以外の指定方法(Cells,Rows,Columns)|VBA入門
7.繰り返し処理(For Next)|VBA入門
8.セルに文字を入れるとは(Range,Value)|VBA入門
9.とにかく書いてみよう(Sub,End Sub)|VBA入門
10.マクロはどこに書くの(VBEの起動)|VBA入門




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


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



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