Eclipse フォーマッターの設定/コードを整形する

・フォーマッター

・フォーマッターとは

・現状のフォーマッターを確認する

・フォーマッターの内容をカスタマイズする

・設定の変更が反映されない場合

・コードを整形する

・コードを整形する方法 (Ctrl + Shift + f)

・一部の箇所は整形を反映させない@formatter

フォーマッターとは

ソースコードのレイアウト（インデント、改行、空白の入れ方など）を自動で整える機能です。

Eclipseには標準で「コード整形ルール」が入っており、[ソース]→[整形](Ctrl+Shift+F)を押すと、選択範囲やファイル全体を自動的に整えてくれます。

フォーマッターでできること

・インデント幅（スペースorタブの数）

・改行位置（if(...){を同じ行に書くか改行するか）

・波かっこのスタイル（K&R,Allmanなど）

・空白の扱い（演算子の前後にスペースを入れるか）

・インポートの整列や折りたたみルール

・JavaDocコメントの折り返し

利用シーン

チーム開発で「コードの見た目を統一」する

自分が書いたコードを後から読みやすく整理する

コーディング規約（例えばSun/Googleスタイル）に合わせる

関連機能

・保存時に自動整形
設定で「保存時にフォーマッターを実行」することも可能

・外部プロファイルのエクスポート/インポート
チームで共通ルールを配布する際に便利

現状のフォーマッターを確認する

１．「ウィンドウ」→「設定」をクリックします。

２．「Java」→「コード・スタイル」→「フォーマッター」をクリックします。
「アクティビティなプロファイル」にあるのが現状のフォーマッターの名称です。
フォーマッターの内容を確認するため「編集」をクリックします。

３．プロファイル名がEclipse[ビルトイン]の内容です。
赤枠にあるタブ・サイズは4となっています。

４．プロファイルは複数あり選択が可能です。
プロファイルの新規追加も可能です。

５．プロファイルは、インポートやエクスポートも行うことができます。

フォーマッターの内容をカスタマイズする

１．「ウィンドウ」→「設定」をクリックします。

２．「Java」→「コード・スタイル」→「フォーマッター」→「新規」をクリックします。

３．「プロファイル名」に任意の名前を入力します。
「次のプロファイルで設定を初期化」でプロファイルのコピー元を選択しOKを押します。

４．例としてタブサイズを４から２に変更します。
右側にあるプレビューで修正内容を確認することができます。
OKを押すと反映されます。

設定の変更が反映されない場合

設定の変更が反映されない場合、プロジェクトのプロパティを確認してみて下さい。

１．プロジェクトを右クリックし「プロパティ」をクリックします。

２．プロジェクトのプロパティを表示し、「Javaコード・スタイル」→「フォーマッター」をクリックし、設定は想定どいりになっているか確認します。

コードを整形する方法 (Ctrl + Shift + f)

Ctrl + Shift + f

1.「Ctrl + Shift + f」を押すと、フォーマッターの設定でコードが整形されます。

「Ctrl + Shift + f」実行前　インデントが取られていません。

「Ctrl + Shift + f」実行後　インデントが取られました。

一部の箇所は整形を反映させない@formatter

// @formatter:off

// @formatter:on

@formatter:offからonの間は、整形が反映されません。

「Ctrl + Shift + f」実行前　@formatterのoffとonがあります。

「Ctrl + Shift + f」実行後　@formatterのoffとonの間は、整形が反映されません。