コードの整形

コード箇所の整形

1. エディターで、整形したいコード箇所を選択します。

   再フォーマットする前に、選択したコードに適用されているコードスタイル設定を確認できます。 Alt+Enter を押して、 コードスタイルの設定を調整する をクリックします。

2. メインメニューで、 コード | コードの整形 に移動するか、 Ctrl+Alt+L を押します。

   または、表示される ツールバーで、 コードの整形 をクリックします。

ファイルを再フォーマットする

1. ファイルをエディターで開いて Ctrl+Alt+Shift+L を押すか、 プロジェクト ツールウィンドウでファイルを右クリックして コードの整形 を選択します。

2. 開いた ファイルの整形 ダイアログで、必要に応じて、次の整形オプションを選択します。

   • インポートの最適化(O): 未使用のインポートを削除する、足りないものを追加する、インポート文を整理するには、このオプションを選択します。

     詳しくは、 インポートの最適化のセクションを参照してください。

   • エントリーの再配置(R): コードスタイル設定で指定された 配置規則に基づいてコードを再配置する必要がある場合は、このオプションを選択します。

   • コードのクリーンアップ: コードクリーンアップインスペクションを実行するには、このオプションを選択します。

   • 改行を保持しない(B): コードスタイルの設定に従って改行を整形します。 このオプションは、 整形時の保持 | 改行 設定を上書きします。

3. 実行 をクリックします。

   

   整形中にコードに加えられた正確な変更を確認するには、 ローカル履歴機能を使用します。

モジュールまたはディレクトリの整形

1. プロジェクト ツールウィンドウで、モジュールまたはディレクトリを右クリックして コードの整形 を選択するか、 Ctrl+Alt+L を押します。

2. 開いたダイアログで、 整形オプションを指定します。

   また、 スコープを指定したり、特定のファイルタイプに整形を絞り込んだりするなど、コードの整形にフィルターを適用することもできます。

   

行インデントの整形

指定した設定に基づいて行のインデントを整形できます。

1. エディター内で、必要なコード箇所を選択して Ctrl+Alt+I を押します。

2. インデント設定を調整する必要がある場合は、 設定 ダイアログ (Ctrl+Alt+S) で エディター | コードスタイル に進みます。 インデントを変更する言語を選択します。

3. タブとインデント タブで、適切なインデントオプションを指定し、 OK をクリックします。

保存時に自動的にコードを整形

変更が 保存されたときに、変更されたファイルのコードを自動的に整形するように IDE を構成できます。

1. Ctrl+Alt+S を押して設定を開き、 ツール | 保存時のアクション を選択します。

2. コードの整形 オプションを有効にします。

3. さらに、IDE がコードを整形する方法を構成できます。

   • スコープの構成… をクリックして、 整形から除外するファイル名とディレクトリのパターンを指定します。

   • すべてのファイルタイプ リストから、コードを整形するファイルのタイプを選択します。

   • プロジェクトがバージョン管理下にある場合は、 ファイル全体 または 変更された行 を選択します。

     変更された行 を選択した場合、整形は、ローカルで変更されたものの、リポジトリにまだチェックインされていないコード行にのみ適用されます。

コミット時にコードを整形する

プロジェクトが バージョン管理されている場合は、リポジトリに変更をコミットするときに、コードを自動的に整形できます。 この場合、追加または変更されたコードのみが整形されます。

1. Alt+0 を押して コミット ツールウィンドウを開き、 コミットオプションを表示 をクリックします。

2. コミットチェック メニューで、 コードの整形 オプションを有効にします。

オプションを有効にすると、コミットするたびに追加または変更されたコードが整形されます。

コマンドラインからコードを再フォーマットする

IntelliJ IDEA は、コマンドラインから指定されたファイルにコードスタイルのフォーマットを適用できます。

1. お使いの OS 用のコマンドラインランチャーがあることを確認してください。

2. format コマンドを実行します。

コマンドラインからファイルをフォーマットする の詳細を参照してください。

整形からファイルを除外する

ファイルとディレクトリのグループを、整形、 コード配置 、および インポートの最適化から除外できます。

1. 設定 ダイアログ (Ctrl+Alt+S) で、 エディター | コードスタイル に進みます。

2. フォーマッター タブに切り替え、 整形しない フィールドに、 グロブパターン(英語)を使用して除外するファイルとディレクトリを入力します。

   セミコロン ; で区切って複数のグロブパターンを指定できます。 をクリックすると、フィールドが展開され、各パターンが別々の行に表示されます。

3. 変更を適用して、ダイアログを閉じます。

   

エディターでの整形からコード箇所を除外

1. 設定 ダイアログ (Ctrl+Alt+S) で、 エディター | コードスタイル に進みます。

2. フォーマッター タブに切り替えて、 コードコメント内のマーカーでフォーマッターのオン/オフを切り替える オプションを有効にします。

3. エディターで、除外する領域の先頭に、行コメント Ctrl+/ を作成し、 @formatter:off と入力します。 領域の最後に、別の行コメントを作成し、 @formatter :on と入力します。

   マーカー間のコードは整形されません。

   

既存のフォーマットを保持

コードを整形するときに無視されるフォーマット規則を選択できます。 例: 単純なメソッドや関数を 1 行に収めるように IDE を調整することができますが、通常はコードの整形後に複数行に展開されます。

1. メインメニューで 設定 | エディター | コードスタイル に移動し、プログラミング言語を選択して、 折り返しと波括弧 タブを開きます。

2. 整形時の保持 セクションで、無視したいフォーマット規則を選択し、適用するものを選択解除します。

3. コードを整形します (Ctrl+Alt+L)。

IntelliJ IDEA は現在のスタイル設定に従ってあなたのコードを整形し、選択したルールのための既存のフォーマットを維持します。