コードの整形

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

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

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

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

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

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

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

   

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

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

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

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

   • 改行を維持しない ：コードスタイル設定に従い、改行を再フォーマットします。 このオプションは、 整形時の保持｜改行 設定を上書きします。

3. 再フォーマット中にコードに加えられた正確な変更内容を確認するには、 ローカル履歴 機能を使用してください。

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

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. エディターで、除外する領域の先頭に「@formatter:off 」と入力します。 領域の末尾に「@formatter :on 」と入力します。

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

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

元のフォーマット:

マーカー内のコードの元のフォーマット (line 72 - line 76) は保持されますが、マーカーのないコード (line 78 - line 81) が再フォーマットされます。

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

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

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

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

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

3. コードを再フォーマットする （Ctrl+Alt+L）。

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