コードの整形

コード箇所の整形

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

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

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

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

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

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

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

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

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

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

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

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

フォルダー内のコードを再フォーマットする

1. プロジェクトビューで、フォルダーを右クリックしてコンテキストメニューから コードの整形​ を選択するか、 Ctrl+Alt+L を押します。

2. 開いたダイアログで、必要なオプションを指定して OK をクリックします。

行インデントの整形

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

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

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

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

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

IDE で、変更されたファイルのコードを 保存時に自動整形するように設定できます。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1. 設定 ダイアログ（Ctrl+Alt+S ）で エディター | コードスタイル に移動します。

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

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

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

   

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

1. 設定 ダイアログ（Ctrl+Alt+S ）で エディター | コードスタイル に移動します。

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

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

   マーカー間のコードは再フォーマットされません。

この例は、2 つのコードフラグメントを示しています。 それらの 1 つは @formatter:off および @formatter:on マーカーで囲まれていますが、もう 1 つは囲まれていません。

元のフォーマットは保持されます。

元のフォーマットは、どちらのコードフラグメントでも保持されません。

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

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

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

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

3. コードを整形する （Ctrl+Alt+L）。

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