【VS Code】Java コードを自動フォーマットする

Java を経験していることをいつも忘れてしまう岩崎真也です。

VS Code で、Java コードのフォーマット設定をしましたので記録しておきます。

拡張機能

「Extension Pack for Java」をインストールする。

設定ファイルを開く

コマンドパレットを開き、「Java: Open Java Formatter Settings with Preview」を選択する。

ダイアログが表示されたら「Yes」を選択する。

設定を変更する

設定は以下のように変更しました。個人的に「else」などは波括弧の次の行に表示したほうが見やすいと感じるため、一部は一般的なフォーマットから設定を変更してあります。

Indentation

• Indentation policy: tab
• tab size: 4

Insert Line

• ✓ Before ‘while’ in a ‘do’ statement
• ✓ Before finally in a ‘do’ statement
• ✓ Before ‘else’ in a ‘do’ statement
• ✓ Before ‘catch’ in a ‘do’ statement

変更したら、「java-formatter.xml」を保存する。

このフォーマッターでは、不要な空行は取り除かれないようです。

VSCode デフォルトフォーマット設定

VSCodeの設定を開く。

「Formatter」で検索する。

「Default Formatter」を None にする。

ファイル全体にフォーマットを適用する

事前にコミットを済ませておく。

ファイルを右クリックして「Format Document」を選択する。

ダイアログが表示されたら「Yes」を選択し、Formatter を選択する。

差分を確認して、不要な折返しなど、戻したい箇所はフォーマットを戻す。

範囲指定にフォーマットを適用する。

範囲指定後に右クリックして「Format Selection」を選択する。

保存時にフォーマットを適用する。

常に自動フォーマットで問題ないのであれば、VS Code の設定で「Format on Save」を有効にする。