【GAS】インデントを一括で整える方法

GAS

スクリプトを作成していると知らない間に規則を忘れて読みにくいコードになっていることがあります。とはいえ、長いインデントをひとつずつ整えるのは面倒。そこで便利なのがエディタに搭載されている自動成形ツールです。

たぬき平社員
たぬき平社員

結論から言うと、Windowは「Shift+alt+f」で、Macは「Shift+option+f」のショートカットキーで一括でインデントが整えられます。

インデントとは

インデントとは、文章の行頭に空白を挿入して先頭の文字を右に押しやることを指します。プログラミングでは、プログラムの構造を見やすくするために制御構文の内側にある行などの先頭に、一律に同じ幅の空白を挿入します。

GASではインデントの数はそこまで問題になりませんが、インデントの数は半角スペース2つまたは4つ分が主流です。プログラミング言語によっては適切なインデントがないとコードが正しく動作しない場合があるので癖づけしておくといいでしょう。

インデントを整える理由

インデントを整える理由は「コードの可読性」のためです。コードの可読性を整えることで、次のような利点があります。

  • 可読性の向上
  • エラーの防止
  • チーム開発の一貫性
  • プログラムの構造を明確化

コードの可読性がよくなると、処理の流れを直感的に把握できるようになり、コードブロックの範囲が明瞭化、それは条件分岐やループのミスを防ぐとに繋がります。

また、統一されたスタイルのインデントは複数人での開発においてコードレビューや保守を円滑に進めるためには欠かせません。インデントを整えることは、部屋を掃除するのと似ていますね。

インデントを整える実例

下記がインデントがバラバラの例です。

function myFunction(){
var data = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet().getDataRange().getValues();
       for(var i=0;i<data.length;i++){
if(data[i][0] === 'たぬき'){
   Logger.log(data[i][1]);
      }
}
    }

今回は短いコードですので、インデントが整えられていなくても、そこまで可読性は悪くありませんが整えてみましょう。

function myFunction() {
  var data = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet().getDataRange().getValues();
  for (var i = 0; i < data.length; i++) {
    if (data[i][0] === 'たぬき') {
      Logger.log(data[i][1]);
    }
  }
}

随分すっきりしましたね。

ブロックで分けられているので、ブロック内の処理の内容をすぐに確認することができ、中括弧のつけ忘れなども防ぐことができます。

インデントを整える方法

冒頭でも説明しましたが、自動成形ツールでインデントを整える方法はWindowは「Shift+alt+f」で、Macは「Shift+option+f」のショートカットキーです。

とはいえ、ショートカットキーで整えられるのはインデントだけです。次のようなコードが整理されませんので注意してコードを書きましょう。

注意点

ショートカットキーで整えられるのはインデントだけです。空白行の削除や長すぎる行の折り返しは自動整形ツールでは対応できません。そのため、不必要な空白行を適宜削除し、コード全体をすっきりと見やすくコードを書きながら整えていくことが大切です。

コメント

タイトルとURLをコピーしました