Android Studioのフォーマッタを局所的に無効化する

2017/05/14

Android Studioの標準フォーマッタは結構賢くて、お任せしてもそこそこいい感じにフォーマットしてくれます。

ただ、フォーマットしてほしくない箇所もあったりしますよね。SQL文を組み立ててるところとか、ワンライナーとか。

そんなときはAndroid Studioの設定を弄ってフォーマッタを局所的に無効にしましょう。

  • File → Settingsを選択して設定画面を開く
  • Editor → Code Styleを開く
  • 中ほどにあるFormatter Controlを以下のように設定する
    • Enable formatter markers in commentsにチェックを入れる
    • Markers欄
      • 『Formatter off:』に『@formatter:off』を入力
      • 『Formatter on:』に『@formatter:on』を入力
設定画面

設定画面

この設定をすると、以下のようなコードがフォーマットされなくなります。

// @formatter:off
for (char c = 'a'; c <= 'z'; c++) { doSomething(); }
// @formatter:on
// @formatter:off
@BindView(R.id.textView1) TextView textView1;
@BindView(R.id.textView2) TextView textView2;
// @formatter:on

これで心置きなくフォーマットできますね。WindowsならショートカットはCtrl+Alt+Lです。

フォーマットは個人のこだわりが強く出るところなので、チーム開発のときは個々に任せるとカオスになりがち。フォーマッタによる強制フォーマットを基本ルールにして、どうしてもなところだけ明示的に除外するのがいいかなあ、と思っています。




関連(するかもしれない)記事


おススメ