GAS初心者のコメント術
GAS初心者のためのコメントの基本
Google Apps Script（GAS）を学び始めるとき、まずはコードに コメント を入れる習慣をつけることが重要です。コメントは実行されないテキストで、他人や自分の将来のためにコードの意図を説明します。GAS初心者は、コメントを入れることで「何をしているか」を明確にし、デバッグ時に役立ちます。
// と /* */ の使い分け
JavaScript系言語では、1 行コメントに //、複数行コメントに /* */ を使います。GAS でも同様です。// はその行の残りをコメント扱いにし、/* */ は開始タグから終了タグまでをコメントにします。例えば：
// これは1行コメント
/* これは
複数行コメント
です */コメントアウトしたいコードが長い場合は /* */ を使うと便利です。
コメントアウトでコードを無効化するテクニック
デバッグや一時的に機能を停止したいときは、コメントアウト でコードを無効化します。// で行単位、/* */ でブロック単位で無効化できます。例えば：
// ここは実行されない
/*
function test() {
Logger.log('test');
}
*/無効化したコードは実行時に無視されるため、エラーを防ぎつつ実装を試すことができます。
コード説明と可読性を高めるメモの書き方
可読性を保つために、コードの前後に メモ を書くことが推奨されます。メモは「何をするか」「なぜ必要か」を簡潔に記述し、後から見たときに理解しやすくします。例えば：
// 取得したメールを配列に格納
var threads = GmailApp.search('label:inbox');
var messages = [];このようにコメントを入れることで、他の開発者や自分自身がコードを読む際にスムーズに把握できます。
ドキュメンテーションと記述ルール
GAS での ドキュメンテーション は、関数やクラスの上に JSDoc 形式で書くと自動補完や型推論に役立ちます。記述ルールとしては：
- 関数名・変数名は
camelCaseを使用 - コメントは日本語で書く場合は
/** */を使う - 必須パラメータは
@paramで明示 - 戻り値は
@returnsで記載
例：
/**
* 指定したラベルのメールを取得します。
* @param {string} label ラベル名
* @returns {GmailThread[]} メールスレッドの配列
*/
function getThreadsByLabel(label) {
return GmailApp.search('label:' + label);
}このように統一した記述ルールを守ることで、チーム開発や長期保守が容易になります。
コメント
コメントを投稿