GASでコメントを書く方法！単行と複数行コメントの記述方法と使い分けを解説
Google Apps Script(GAS)のコードを書く際に大切なのはコメントを書くことです。
GASのコードの処理内容をコメントで説明することで、可読性が高まります。
そこでGASのコードにコメントを書く方法を解説します。
GASのコードで大切なのは可読性
Google Apps Script(GAS)でコードを書く上で大切なのは可読性です。
コードの可読性というのは「コードの読みやすさ」を意味します。
GASのコードは一度書いて終わりということはほとんどありません。
あとで処理内容が変わることでコードを変更するケースや使用していたサービスやライブラリが終了して書き換えるケースもあります。
時間が経過した際に「このGASコードは何を書いている？」と分からなくなりがちです。
そこで、コードの可読性を高めておくことで、コードをメンテナンス(保守)する際にコードを読み解いて理解するコストを削減することができます。
複数人のGAS開発では可読性が保守性に
また、複数人でGASの開発を行っている場合、可読性というのはさらに重要です。
コードを書いた自分は理解できていても、他の人は理解できないケースが多く発生します。
同じコードを別の人が修正する際に、コードが理解できていないと正しい修正ができません。
コードの保守性(メンテナンスしやすさ)のために、複数人でのGAS開発ではコードの処理効率性よりも可読性を重視する運用も多いです。
他の人がGASコードを読んでも理解しやすいように可読性を高めることが、GAS中級者以上には求められます。
コードの可読性を高めるのに大切なコメント
Google Apps Script(GAS)のコードの可読性を高めるために重要なのがコメントを書くことです。
コメントとはコードの処理として実行されないコード内のメモ書き・注釈です。
コメントはGASの実行においては無視されるため、処理内容に直接影響はありません。
コードに書いた処理の内容や処理の注意点を記述するのに利用されます。
コメントを書いておくことで処理内容を説明することができ、可読性を高めることができます。
GASのコメントの記述方法は2種類
Google Apps Script(GAS)のコードにおいてコメントを書くために2種類の記法が用意されています。
- 「//」による単行コメント
- 「/* */」による複数行コメント
それぞれのコメント記述方法を解説していきます。
「//」による単行コメント
１つ目は「//」による単一行のコメントです。
Google Apps Script(GAS)のコード行の先頭に//を入力すると、入力行はコードとして処理されずにコメントになります。
function singleComment() {
//変数に文字列を定義
const text = 'テストテキスト';
}実行内容の簡単な説明や注釈に使うのに便利です。
実行不要になったコード行の先頭に//を付与することで処理をスキップさせる使い方も可能です。
このように「//」を使うことで1行コメントをGASコードに挿入可能です。
「/* */」による複数行コメント
２つ目は「/* */」を使った複数行のコメントです。
「/*」を入力して改行を含めて「*/」を入力するまではすべてコメントとしてGAS実行時は無視されます。
function multiComment() {
/* 複数行コメント
コメント記号に囲まれたエリア
はコメントとして実行されない
*/
console.log('コメントテスト');
}「//」による単行コメントよりも何行にもわたってコメントを入力することができます。
GAS関数のコードの中で使わなくなったけど、一定期間は残しておきたい場合に「/* */」で当該箇所を囲んでコメントアウトすることにも使われます。
単行・複数行コメントの使い分け法
単一行コメントと複数行コメントの2つのコメントの書き方はどのように使い分ければよいでしょうか。
コメントの書く記述量に応じて1行で収まるなら「//」、収まらないなら「/* */」を使うイメージです。
ただ、Google Apps Scriptの関数内に複数行コメントを入れる場合、コード修正時にコメント部分も消してしまい、実行エラーになることがあります。
そのため、関数内ではできるだけ1行に収まる分量のコメントがおすすめです。
複数行コメントを使う場合は、GASの関数の処理内容の概要を書く際に使うとよいです。
関数の目的や引数の指定内容、戻り値が何かをフォーマットとして書くとGAS関数の用途が他の人が理解しやすくなります。
コメントの基準・粒度はどれぐらい？
コメントを書く中で気になるのがどういった基準や粒度です。
どういった箇所でコメントを書くか、どれぐらいの粒度で説明を記述するか判断に迷います。
ただ、Google Apps Script(GAS)においては1行ずつコードの実行内容をコメントとして書いてもよいと考えています。
GASを利用しているユーザーの多くはプログラミングの習熟度が高い人よりも、非エンジニアのような人も多いです。
だからこそGASに詳しくない人でもわかりやすくコメントを充実させるのが大切です。
もちろん複数人でGASのコードを書いていて、一定の水準レベルを突破していれば、コメントが不要なケースもあります。
しかし、人事異動や担当変更でGASに詳しくない新たな担当者が増えるかもしれません。
そうした点を踏まえると、1行ごとにコードの実行内容を詳しくコメントで説明するのがおすすめです。
まとめ・終わりに
今回、Google Apps Script(GAS)のコード内でコメントを書く方法を紹介しました。
GASのコメントには「//」による単行コメントと「/* */」で囲む複数行コメントの2種類があります。
コメントの記述したい分量で2つのコメント記述方法を使い分けますが、短くまとめられるなら単一行のコメントがおすすめです。
関数の利用用途や引数・戻り値を説明したい場合などで複数行コメントをよく利用します。
コメントによってGASのコードを可読性を高められるので、プログラミング初心者の利用も多いGASではコメントはできるだけ詳しく書くことをおすすめします。