Javaコードの特定のセクションでEclipseコードフォーマッターをオフにする方法

Java文字列として記述されたSQLステートメントを含むJavaコードをいくつか持っています（OR / Mフレームワールは使用しないでください。埋め込まれたSQLはそれです-私の決定ではありません）。

メンテナンスを容易にするために、SQLステートメントを意味的にいくつかのコード行に連結された複数の文字列に分割しました。したがって、次のようなものの代わりに：

String query = "SELECT FOO, BAR, BAZ FROM ABC WHERE BAR > 4";

私のようなものがあります：

String query =
    "SELECT FOO, BAR, BAZ" +
    "  FROM ABC          " +
    " WHERE BAR > 4      ";

このスタイルにより、特に大規模なクエリの場合に、SQLが非常に読みやすく、維持されます（IMHO）。たとえば、エディターを「上書き」モードにして、テキストをその場で簡単に変更できます。

この問題は、SQLの特定の例を超えて一般化することに注意してください。垂直方向の書式、特に表形式の構成で記述されたコードは、きれいなプリンターによって破壊されやすくなります。

現在、一部のプロジェクトメンバーはEclipseエディターを使用しており、ソースファイル全体をフォーマットすると、セマンティックフォーマットが破壊されることがよくあります。

フォーマットに関してソースの特定の行を無視するようにEclipseに指示する方法はありますか？

Eclipseフォーマッターを切り替える特別なコメントのようなものを探しています。理想的には、そのようなコメントは私たちが選択したものになるように構成可能であり、他のフォーマッターもそれを尊重するようにプログラムできます。

// STOP-ECLIPSE-FORMATTING
String query =
    "SELECT FOO, BAR, BAZ" +
    "  FROM ABC          " +
    " WHERE BAR > 4      ";
// START-ECLIPSE-FORMATTING

明らかに、「解決策」の1つは、JalopyやJIndentなどの外部フォーマッターでチームメンバーを標準化することですが、これはこの質問の目的ではありません（また、このプロジェクトに対する私の決定ではありません）。具体的には、アドホックベースでEclipseフォーマッターを使用しないでください。

理想的には、ソリューションを使用すると、Eclipse を使用してチームメンバーがIDEの再構成を行う必要なく、Eclipseフォーマッターの指示を挿入できます（フォーマッターに依存しないコマンドコメントを選択する以外に：STOP-ECLIPSE-FORMATTING→ STOP-FORMATTING）。

Eclipse 3.6では、次のような特別なコメントを付けることで、フォーマットをオフにすることができます

// @formatter:off
...
// @formatter:on

Eclipse設定で、オン/オフ機能を「オン」にする必要がありますJava > Code Style > Formatter。クリックしてEdit、Off/On Tags有効Enable Off/On tags。

設定で魔法の文字列を変更することも可能です。Eclipse3.6のドキュメントをチェックしてください。

詳しくは

Java > Code Style > Formatter > Edit > Off/On Tags

この設定では、フォーマッタを無効にする1つのタグと有効にする1つのタグを定義できます（フォーマッタプロファイルの[オフ/オンタグ]タブを参照）。

また、からフラグを有効にする必要があります Java Formatting

フォーマッター上のEclipse 3.5 M4のAFAIKには、ユーザー行の改行を保持する「行を結合しない」オプションがあります。多分それはあなたが望むことをします。

そうでなければ、この醜いハックがあります

String query = //
    "SELECT FOO, BAR, BAZ" + //
    "  FROM ABC"           + //
    " WHERE BAR > 4";

SOでこの回答を参照してください。

特定のブロックコメントのフォーマットを抑制するために使用できる別のソリューションがあります。/*-ブロックコメントの先頭で（ハイフンに注意）を使用します。残りのファイルをフォーマットしても、フォーマットには影響しません。

/*-
 * Here is a block comment with some very special
 * formatting that I want indent(1) to ignore.
 *
 *    one
 *        two
 *            three
 */

出典：Oracleのドキュメント。

書式設定をオフにする代わりに、既に折り返されている行を結合しないように構成できます。Jitterの応答と同様に、Eclipse STSの場合は次のようになります。

プロパティ→Javaコードスタイル→フォーマッタ→プロジェクト固有の設定を有効にする、またはワークスペース設定の構成→編集→行の折り返し（タブ）→「既に折り返された行を結合しない」にチェックを入れる

保存して適用します。

フォーマッタタグを追加する機能をオンにする必要があります。メニューバーで次の場所に移動します。

Windows → Preferences Java → Code Style → Formatter

押しEditボタンを。最後のタブを選択します。オン/オフボックスを確認し、チェックボックスで有効にします。

行の先頭にプラス記号を付けると、フォーマットが異なります。

String query = 
    "SELECT FOO, BAR, BAZ" 
    +    "  FROM ABC"           
    +    " WHERE BAR > 4";

フォーマッターがSQL文字列のインデントをめちゃくちゃにしないように、固定幅の文字列部分（空白で埋められた）を使用しています。これは混合結果をもたらし、SQLのように空白が無視されない場合は機能しませんが、役立つ場合があります。

    final String sql = "SELECT v.value FROM properties p               "
            + "JOIN property_values v ON p.property_id = v.property_id "
            + "WHERE p.product_id = ?                                  "
            + "AND v.value        IS NOT NULL                          ";

各行の最後に二重スラッシュ「//」を付けます。それは日食がそれらをすべて同じ行に移動するのを防ぎます。

代替方法：Eclipse 3.6では、[行の折り返し]の[一般設定]に、[既に折り返された行を結合しない]オプションがあります。つまり、フォーマッターは長い行を折り返しますが、既に持っている折り返しは元に戻しません。

@xpmatteoはコードの一部を無効にする答えを持っていますが、これに加えて、デフォルトのEclipse設定は、ファイル全体ではなく、編集されたコード行のみをフォーマットするように設定する必要があります。

Preferences->Java->Editor->Save Actions->Format Source Code->Format Edited Lines

同僚が実際に変更しなかったコードを再フォーマットしているため、これは最初からそれを防ぐことができたでしょう。これは、ソースコントロールのdiffが役に立たない事故を防ぐための良い方法です（形式設定のわずかな違いによりファイル全体が再フォーマットされる場合）。

また、タグのオン/オフオプションがオフになっている場合、再フォーマットも防止されます。

ファントムコメントは、//新しい行を追加する場所を追加するのに最適です。

1. @formatter：offは、コードからエディターへの参照を追加します。私の意見では、コードにはそのような参照があってはなりません。

2. ファントムコメント（//）は、使用するフォーマットツールに関係なく機能します。Eclipse、InteliJ、または使用するエディターに関係なく。これは非常に素晴らしいGoogle Java Formatsでも動作します

3. ファントムコメント（//）はアプリケーション全体で機能します。JavaScriptもあり、おそらくJSBeautifierのようなものを使用している場合。JavaScriptでも同様のコードスタイルを使用できます。

4. 実際、おそらく正しいフォーマットが必要ですか？タブ/スペースの混合と末尾のスペースを削除したい。コード標準に従って行をインデントしたいとします。あなたが望まないことは長い列です。それ、そしてそれだけが、ファントムコメントがあなたに与えるものです！

このハックは機能します：

String x = "s" + //Formatter Hack
    "a" + //
    "c" + //
    "d";

フォーマッタを使用しないことをお勧めします。悪いコードは人為的に良いわけではなく見た目が悪いはずです。良いコードは時間がかかります。あなたは品質をだますことはできません。書式設定はソースコードの品質の一部です。