第9回.コメントの書き方
Google Apps Scriptはプログラミング言語です。
単語の組み合わせ、単語の省略形、記号等で出来ています。
コメントアウトの書き方
行頭および行の途中に、
//
を書くと、それ以降がコメントアウトされます。
/*から*/の間は、コメントアウトされます。
行の途中でこれを使う意味はないので、
通常は、複数行をまとめてコメントアウトする時に使います。
/*
この間は何行でも全てコメントアウトになります。
*/
コメントアウトは、他と見分けがつきやすいように色分けされて表示されます。
//
を書くと、それ以降がコメントアウトされます。
行の途中でこれを使う意味はないので、
通常は、複数行をまとめてコメントアウトする時に使います。
/*
この間は何行でも全てコメントアウトになります。
*/
コメントの必要性
スクリプトにコメントを書くことで、
後で見たとき、他人が見たときに、分かりやすくしておきます。
前回書いたスクリプトですが、
これだけ見たのでは、何をやっているか全くわかりません。
スプレッドシートと見比べて、初めて処理内容が理解できます。
// 金額（D列） = 単価（B列） × 数量（C列）
これを追加しています。
たったこれだけで、何をしているのかが一目瞭然で分かるようになります。
半年後、一年後に、スクリプトを見直したときコメントのありがたさが実感できるでしょう。
また、他人とスクリプトを共有する場合は特に、このコメントが役に立ちます。
後で見たとき、他人が見たときに、分かりやすくしておきます。
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入門」の記事
・セルの値の取得と設定 ・完成スクリプト、その1 ・解説、その1 ・完成スクリプト、その2 ・解説、その2 ・算術演算子（四則演算子） ・セルの値を使って計算するの最後に
第7回.同じ計算を行数分繰り返す・同じ計算を行数分繰り返すとは ・前回のスクリプト ・完成スクリプト ・スクリプトの解説 ・forの詳細 ・ブロック文 ・同じ計算を行数分繰り返すの最後に
第8回.最終行を取得して繰り返す・前回の復習 ・完成スクリプト ・スクリプトの解説 ・指定列の最終行 ・最終行を取得して繰り返すの最後に
第9回.コメントの書き方第10回.条件で処理を変える（条件分岐,if）
・条件分岐(if)の例題 ・完成コード ・if...else文の説明 ・比較演算子 ・論理演算子 ・ビット演算子 ・条件分岐(if)の最後に
第11回.条件で処理を変える（条件分岐,switch）・条件分岐(switch)の例題 ・完成コード ・switch文の説明 ・条件分岐(switch)の最後に
第12回.表範囲をまとめて消去する・セルの値の消去 ・データ部分だけを消去する例題 ・完成スクリプト ・スクリプトの解説 ・VBAのCurrentRegionについて ・表範囲をまとめて消去の最後に
第13回.セルに書式を設定する・書式を設定する例題 ・罫線 ・塗りつぶし ・フォント サイズ ・太字 ・CSSの色設定 ・完成スクリプト ・設定されている書式の取得 ・セルに書式を設定の最後に
第14回.複数のシートを扱う・複数のシートを扱う例題 ・シート名でシートを取得 ・インデックスでシートを取得 ・シート数を取得 ・る ・複数のシートの最後に
第15回.複数のスプレッドシートを扱う・他のスプレッドシートの指定方法 ・完成スクリプト ・文字列結合 ・複数のスプレッドシートの最後に
第16回.Google Apps Scriptの文法・記述のルール ・変数・定数の宣言 ・命名規則
新着記事NEW ・・・新着記事一覧を見る
ブール型（Boolean）のis変数・フラグについて｜VBA技術解説(2024-04-05)
テキストの内容によって図形を削除する｜VBA技術解説(2024-04-02)
ExcelマクロVBA入門目次｜エクセルの神髄(2024-03-20)
VBA10大躓きポイント（初心者が躓きやすいポイント）｜VBA技術解説(2024-03-05)
テンキーのスクリーンキーボード作成｜ユーザーフォーム入門(2024-02-26)
無効な前方参照か、コンパイルされていない種類への参照です。｜エクセル雑感(2024-02-17)
初級脱出10問パック｜VBA練習問題(2024-01-24)
累計を求める数式あれこれ｜エクセル関数応用(2024-01-22)
複数の文字列を検索して置換するSUBSTITUTE｜エクセル入門(2024-01-03)
いくつかの数式の計算中にリソース不足になりました。｜エクセル雑感(2023-12-28)
アクセスランキング ・・・ ランキング一覧を見る
1.最終行の取得（End,Rows.Count）｜VBA入門
2.セルのコピー&値の貼り付け（PasteSpecial）｜VBA入門
3.RangeとCellsの使い方｜VBA入門
4.ひらがな⇔カタカナの変換｜エクセル基本操作
5.繰り返し処理（For Next)｜VBA入門
6.変数宣言のDimとデータ型｜VBA入門
7.ブックを閉じる・保存（Close,Save,SaveAs）｜VBA入門
8.並べ替え（Sort）｜VBA入門
9.セルのクリア（Clear,ClearContents）｜VBA入門
10.Findメソッド（Find,FindNext,FindPrevious）｜VBA入門
- ホーム
- その他
- Google Apps Script入門
- コメントの書き方
このサイトがお役に立ちましたら「シェア」「Bookmark」をお願いいたします。
記述には細心の注意をしたつもりですが、
間違いやご指摘がありましたら、「お問い合わせ」からお知らせいただけると幸いです。
掲載のVBAコードは動作を保証するものではなく、あくまでVBA学習のサンプルとして掲載しています。
掲載のVBAコードは自己責任でご使用ください。万一データ破損等の損害が発生しても責任は負いません。