VSCodeでJavaフォーマッタの設定

CheckstyleによるJavaコーディングルールの適用と合わせて、フォーマッタ設定をしておくと快適です。

フォーマッタ設定ファイルの取得

VSCodeのJava機能は、内部的にEclipseと同じ機能を使っているため、Eclipseの設定ファイルを入手して設定することで可能です。

https://github.com/google/styleguide/blob/gh-pages/eclipse-java-google-style.xml こちらからeclipse-java-google-style.xmlをダウンロードします。

この設定ファイルをダウンロードせずURLとして指定することも可能ですが、設定をプロジェクトごとにカスタマイズする場合はダウンロードしてローカルに保存したものを使用します。

VSCode上での設定

VSCode上の設定で、検索ボックスに java.formatまで入力すると該当の設定値に絞り込めます。

User設定ではなく、プロジェクトごとの設定という考えから、Workspaceの方のタブ設定します。

Java > Format > Settings: Profile でGoogleStyleを指定。

Java > Format > Settings: Url で eclipse-java-google-style.xml
(ローカルにファイルを置かずに、URLで指定する場合は、https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml というように指定します。)

動作確認

フォーマットが乱れたソースコードです。

メニューから、 View > Command Palette でコマンドパレットを表示して、fomatまで入力すると Format Documentを選ぶと手動でフォーマットを実行できます。

設定でEditor: Format On Saveをチェックすると、ファイルを保存したときに自動フォーマットするようにできます。原則的にははじめからこの設定をしておくのが良いです。

しかしながらすでにフォーマットが乱れたソースコードがある状態で、変更差分を発生させたくないケースでは、範囲指定して手動フォーマットしたほうがいいかもしれません。

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)