PhpStorm 2024.3 ヘルプ

コードの整形

PhpStorm を使用すると、現在のコードスタイルスキームまたは .editorconfig ファイルで指定した要件に従ってコードを再フォーマットできます。.editorconfig で定義されていないものがあれば、プロジェクト設定から取得されます。

コードの一部、ファイル全体、ファイルのグループ、ディレクトリを再フォーマットできます。コードの一部または一部のファイルを再フォーマットから除外することもできます。

コードフラグメントを再フォーマットする

  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 を押してコミットツールウィンドウを開き、コミットオプションを表示 the Settings button をクリックします。

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

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

Reformatting code on commit

再フォーマットからファイルを除外する

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

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

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

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

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

    Specifying a glob pattern for excluding files from reformatting

エディターでのコードフラグメントの再フォーマットからの除外

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

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

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

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

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

Formatting markers off

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

Formatting markers off

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

Formatting markers off

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

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

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

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

  3. コードを再フォーマットする (Ctrl+Alt+L).

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

関連ページ:

コードスタイルスキーム

特定のコーディングガイドラインが企業内に存在する場合は、ソースコードを作成する際に、このガイドラインに従わなければなりません。PhpStorm は、必要なコードスタイルを維持できます。IDE には、プロジェクトスキームとデフォルトスキームの 2 つの定義済みスキームが付属しています。プロジェクトスキームでは、構成する設定は現在のプロジェクトにのみ適用されます。これらの設定は、.idea の codeStyles フォルダーに保存され、VCS を介してプロジェクトと共有されます。プロジェクトのコードスタ...

EditorConfig

PhpStorm を使用すると、EditorConfig をサポートする個々のファイルセットのすべてのコードスタイル設定を管理できます。必要なのは定義したいコードスタイルのファイルを含むルートディレクトリに .editorconfig ファイルを置くことです。プロジェクトに複数のコードスタイルがある場合(たとえば、テスト用や本番コード用)、プロジェクトの対応するフォルダーに複数の .editorconfig ファイルを含めることができます。これにより、同時に複数のコードスタイル標準に従うことができます。....

ソースコードの作成と編集

コードを使用する場合、PhpStorm は作業にストレスがないことを保証します。追加、選択、コピー、移動、編集、折りたたみ、出現箇所の検索、コードの保存に役立つさまざまなショートカットと機能を提供します。エディター内のナビゲーションについては、エディターの基本を参照してください。ファイルの読み取り専用属性の切り替えファイルが読み取り専用の場合、ステータスバー、エディタータブ、プロジェクトツールウィンドウで、閉じた鍵のアイコンがマークされます。ファイルが書き込み可能である場合、ステータスバーに開い...

ファイルの再フォーマットダイアログ

現在のファイルのエディターでを押すとダイアログが表示されます。メインメニューからを選択するかを押すと、PhpStorm は指定されたスコープのソースコードを自動的に再フォーマットしようとします。再フォーマット、またはフォーマットからのファイルの除外の詳細については、「コードの整形」を参照してください。VCS にコミットされていない変更のみこのチェックボックスが選択されている場合、再フォーマットは、ローカルで変更されたが、リポジトリにまだチェックインされていないコードにのみ適用されます。このオ...

自動インポート

現在のファイルの外部で定義されている PHP クラスを参照すると、PhpStorm はそのクラス定義を見つけて、次のいずれかを実行できます。クラスが定義されている名前空間を含む、完全修飾クラス名を自動的に補完します。短いクラス名を自動的に補完させ、クラスが定義されている名前空間をインポートします。クイックフィックスを使用してネームスペースを手動でインポートします。ステートメントがインポートセクションに追加されますが、キャレットは現在の位置から移動せず、現在の編集セッションは中断されません。この機...

コードの再配置

配置ルールの構成:設定ダイアログのコードスタイル: PHP ページで設定された配置規則に従って、コードを再配置できます。グループ化ルールを構成するグループ化ルールを使用すると、関連するクラスメソッドをまとめることができます。を押して設定を開き、エディター | コードスタイル | PHP を選択します。配置タブで、グループ化ルール領域のグループ化オプションを選択します。依存メソッドをまとめるオプションの場合、深さ優先で並べ替えまたは幅優先で並べ替えを選択できます。前者はネスト階層に従ってメソッドを配...