Zenn
☕

IntelliJ IDEAでのフォーマット

2022/11/03に公開
Java
IntelliJ IDEA
tech

今まで気になってはいたのですが、疎かにしていたフォーマットの設定を行います。

環境情報

筆者の環境は以下の通りです。

分類 環境
PC MacBook Air(M1, 2020)
OS macOS Monterey(バージョン12.3.1)
IDE IntelliJ IDEA 2022.2.2 (Community Edition)

使用するコードスタイル

IntelliJ IDEAの標準のコードスタイルの設定をPreferenceのEditor -> Code Style -> Javaで確認してみます。

特に違和感ないのですが、今回は勉強の意味を込めて、あえてGoogle Java Styleをインポートしてみたいと思います。
https://google.github.io/styleguide/javaguide.html

コードスタイルのインポート

  • IntelliJ IDEA用のコードスタイルが用意されているので、開きます。
    https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml

  • 業務で使用する場合、共有すると思うので、プロジェクトの/settings/intellij-java-google-style.xmlに空のファイルを新規に作成します。

  • GitHubで開いているスタイルのテキストをコピーして、貼り付けます。
    ※GitHubから一つだけファイルをダウンロードするの地味に面倒なので貼り付けちゃってます。

  • IntelliJ IDEAのPreferenceのEditor -> Code Style -> Javaを開きます。
    設定ボタンをクリックして、Import Schema -> IntelliJ IDEA code style XMLを選択します。

  • 先ほど保存した/settings/intellij-java-google-style.xmlを選択します。

  • 名称を変更することもできますが、デフォルトのままでインポートします。

  • インポートされていることを確認します。

再フォーマット(Reformat)実行

今までフォーマットしてこなかったので、ソースコード全体をフォーマットします。

  • Projectビューからsrcフォルダを選択

  • メニューからCode -> Reformat Codeを選択します。

  • 実行したら再フォーマットが必要なファイルはフォーマットされ、保存されます。

保存時にコードを自動的に再フォーマット

毎回手動でフォーマットしなくても良いように保存時に再フォーマットされるように設定します。
公式マニュアルにやり方が記載されています。

https://pleiades.io/help/idea/reformat-and-rearrange-code.html#reformat-on-save

Preferenceを開いて、Tools -> Actions on Saveを選択して、実行したい処理にチェックを入れて、OKを押せば完了です。

ためしに不要なimport文などを記載して、Saveしてみて、自動で削除されると問題なく動作していることが確認できます。

では、記事は以上となります。

Discussion