Eclipse の使用スキルコードとコメントの書式設定

Eclipse では、Ctrl+Shift+f の組み合わせボタンを使用してコードを書式設定できます。書式設定されたコードは整然としており、スタイルが統一されています。チーム開発では、コードの統一されたスタイルが非常に必要です。
自動整形ではコード自体やコメント部分も自動的に整形されるため、実際の開発では以下のような問題が発生する可能性があります。

コメント: 一般的なコメントは特定の書式と組版に従って展開されていますが、書式設定後はめちゃくちゃになり、可読性が失われます。
コード: コードの一部にはロジックやその他の考慮事項がある場合がありますが、Spring Security のセキュリティ構成コードなど、設定された改行またはインデントのスタイルを維持し、関連する構成がまとめられることを期待しています。

この対応には 2 つの機能が必要です。
1. コメント部分は自動整形する必要がない
2. 一部のコードは整形時に例外となり、自動整形は実行されない

Eclipse は上記の機能をサポートしているため、関連する設定を行うだけで済みます。

コードコメントが自動的にフォーマットされないように設定する

コメントの書式設定の例

コードコメントテンプレートはEclipseに設定されており、自動生成されるクラスコメントは以下のとおりです。
ここに画像の説明を挿入

しかし、Ctrl+Shift+f の組み合わせボタンを使用してコードをフォーマットすると、クラスのコメントの組版がおかしくなります。
ここに画像の説明を挿入

クラスコメントのフォーマットを解除する

設定は次のとおりです:
[Windows] > [環境設定] > [Java] > [コードスタイル] > [フォーマッタ] > [編集] > [コメント]。
ここに画像の説明を挿入

「Javadoc コメントの書式設定を有効にする」のチェックを外します。

注: Eclipse の組み込みコードスタイルは変更できません。変更するには、自分でコードスタイルを作成する必要があります。
ここに画像の説明を挿入

追加のコードフォーマット

// @formatter:off次のコードの書式設定をオフにするには、次のコマンドを使用します。
// @formatter:on自動フォーマットを有効にするにはを使用します。そのため、とを
ペアで使用すると、これら 2 つのタグ間のコードが自動的にフォーマットされないことがわかります。// @formatter:off// @formatter:on

	// @formatter:off
	public void method()   {  System.out.println("hello");  }
	// @formatter:on

さらに、自動フォーマットをオフまたはオンにするためのラベルもカスタマイズできます。設定方法は上記の設定と同様で、設定するOff/On Tagsブロックを見つけます。

ここに画像の説明を挿入