PhpStorm 2020.2 ヘルプ

コードの再フォーマットと再配置

PhpStorm では、コードスタイル設定で指定した要件に従ってコードを再フォーマットできます。ただし、プロジェクトで EditorConfig を使用する場合、.editorconfig ファイルで指定されたオプションは、コードを再フォーマットするときにコードスタイル設定で指定されたオプションをオーバーライドします。

設定にアクセスするには、設定 / 環境設定ダイアログ Ctrl+Alt+Sエディター | コードスタイルに移動します。詳細については、コードスタイルの構成を参照してください。

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

ファイル内のコードフラグメントを再フォーマットする

  1. エディターで、再フォーマットしたいコードフラグメントを選択します。

  2. メインメニューからコード | 再フォーマット Ctrl+Alt+L を選択します。

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

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

  2. 開いたダイアログで、必要に応じて、次の再フォーマットオプションを選択します。

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

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

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

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

    Reformat Files dialog

    OK をクリックします。

    再フォーマット中にコードに加えられた正確な変更を確認するには、ローカルヒストリー機能を使用します。

行のインデントを再フォーマットする

指定した設定に基づいて行のインデントを再フォーマットできます。

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

  2. インデント設定を調整する必要がある場合は、設定 / 環境設定ダイアログ Ctrl+Alt+Sエディター | コードスタイルに進みます。

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

再フォーマットからコードまたはファイルを除外する

ファイルのグループまたはコードの一部を再フォーマットから除外することができます。

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

  2. フォーマッター制御タブで、コメントでフォーマッターマーカーを使用可能にするチェックボックスを選択します。スコープエリアがアクティブになります

  3. スコープ領域で、the Add iconをクリックして、再フォーマットから除外するファイルを指定できるスコープを追加します。

除外されたファイルを再フォーマットしようとすると、PhpStorm は、このファイルのフォーマットが無効であることを通知するポップアップを表示します。必要に応じて、ポップアップのリンクをクリックしてコードスタイル設定ページを開き、除外範囲を変更します。

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

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | コードスタイルに移動し、フォーマッター制御タブのコメントでフォーマッターマーカーを使用可能にするチェックボックスを選択します。

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

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

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

  1. 設定 / 環境設定 | エディター | コードスタイルにジャンプし、あなたのプログラミング言語を選択し、折り返しおよび括弧タブを開いてください。

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

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

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

コードの再配置

設定 / 環境設定ダイアログのコードスタイル : PHP ページで設定された配置規則に従って、コードを再配置できます。

グループ化ルールを構成する

グループ化ルールを使用すると、関連するクラスメソッドをまとめることができます。

  • 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | コードスタイル | PHP に移動します。配置タブで、グループ化ルール領域のグループ化オプションを選択します。

    Grouping rules example

    依存するメソッドをまとめるオプションの場合、深さ優先または幅優先を選択できます。前者はネスト階層に従ってメソッドを配置します。後者は、同じネストレベルの兄弟メソッドをグループ化します。

    class foo { public function parent() { $this->child1(); $this->child2(); } private function child1() { $this->nested1(); } private function nested1() { $this->nested2(); } private function nested2() { } private function child2() { } }
    class foo { public function parent() { $this->child1(); $this->child2(); } private function child1() { $this->nested1(); } private function child2() { } private function nested1() { $this->nested2(); } private function nested2() { } }

一致ルールを作成する

一致ルールを使用すると、要素の順序をルールのリストとして定義できます。すべてのルールには、修飾子やタイプなどの一致条件のセットがあります。

  • 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | コードスタイル | PHP に移動します。配置タブで、the Add buttonをクリックして、一致ルール領域にルールパラメーターを入力します。

    • タイプおよび修飾子フィルターを使用して、ルールによって規制する必要があるコード構成とその可視性修飾子を選択します。フィルターをダブルクリックすると、条件が無効になることに注意してください。

    • 名前フィールドを使用して、ルールが影響を与えるエントリ名を指定します。このフィルターは、プロパティ名、メソッド名、クラス名などのエントリ名のみに一致します。フィルターは正規表現をサポートし、標準の構文を使用します。名前全体に対して照合が実行されます。

    • コードエントリをアルファベット順に並べ替えるには、適切な一致ルールエントリを選択し、順序フィールドを名前順に並べ替えます。

      Matching rules example

    ルールのグループ(エイリアス)を作成するを使用して、新しい一致ルールを作成するときに参照することもできます。

ルールエイリアスを作成する

エイリアスを使用すると、複数の配置ルールを 1 つのエンティティにグループ化し、新しい一致ルールを追加するときにそれを参照できます。

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | コードスタイル | PHP に移動します。配置タブで、Configure matching rules aliasesをクリックします。

  2. 開いたルールエイリアス定義ダイアログで、グループ名とそのルールを追加します。

    Rules Alias Definitions

作成されたエイリアスは、一致ルールを追加するときに参照できるようになりました。

Matching rules alias example

セクションルールを作成する

セクションルールを使用すると、メソッドまたは変数を、定義したセクションに移動できます。

  • 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | コードスタイル | PHP に移動します。配置タブで、the Add Section Rule buttonをクリックして、一致ルール領域にルールパラメーターを入力します。

    例:以下のセクションルールを作成することができます。

    A section matching rule example

    アレンジ後、クラス内のメソッドは、作成されたセクションルールで指定されているように再配置され、コメントに囲まれます。

    //methods start public function test() {} private function a() { return 1; } static function r() {} //methods end

コードエントリの並べ替え

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

  2. 配置規則を作成する言語を選択します。

  3. 配置タブで、グループ化ルールや一致ルールなどの適切なオプションを指定します。

  4. 変更を保存するには、OK をクリックします。

  5. エディターで、並べ替えるコードエントリを選択し、メインメニューからコード | コードの再配置を選択します。

最終更新日 : 2020 年 9 月 09 日

関連ページ:

コードスタイルの構成

特定のコーディングガイドラインが企業内に存在する場合は、ソースコードを作成する際に、このガイドラインに従わなければなりません。PhpStormは、必要なコードスタイルを維持できます。コードスタイルは、プロジェクトレベルとIDEレベル(グローバル)で定義されます。プロジェクトレベルでは、設定はプロジェ...

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

コード | コードの再フォーマット現在のファイルのエディターで を押すとダイアログが表示されます。メインメニューからコード | コードの再フォーマットを選択するか を押すと、PhpStormは指定されたスコープのソースコードを自動的に再フォーマットしようとします。再フォーマット、またはファイルをフ...

自動インポート

現在のファイルの外部で定義されている PHP クラスを参照すると、PhpStorm はそのクラス定義を見つけて、次のいずれかを実行できます。クラスが定義されている名前空間を含む、完全修飾クラス名を自動的に補完します。短いクラス名を自動的に補完させ、クラスが定義されている名前空間をインポートします。ク...

スコープ

macOSのPhpStorm | 環境設定 | 外観および振る舞い | スコープスコープは、さまざまな操作が適用されるファイルのセットです。このダイアログを使用して、さまざまなPhpStormアクション(使用箇所の検索やコードインスペクションなど)のスコープを定義できます。メイン・ツールバー:スコー...

コードスタイル : PHP

Windows および Linux 用のファイル | 設定 | エディター | コードスタイル | PHPmacOSのPhpStorm | 環境設定 | エディター | コードスタイル | PHPこのページを使用して、PHP ファイルのフォーマットオプションを設定します。こ...

ルールエイリアス定義ダイアログ

複数の配置ルールをエイリアスにグループ化し、コード・スタイル: PHPの配置タブでマッチングルールを追加するときに参照できます。詳細は、コードの再配置を参照してください。<エイリアス名>このエリアを使用して、新しいエイリアス定義を追加するか、既存のエイリアス定義を確認するか、不要なものを...