Comment désactiver le formateur de code d'Eclipse pour certaines sections du code Java ?

Question

J'ai du code Java avec des instructions SQL écrites sous forme de chaînes Java (s'il vous plaît, pas de querelles OR/M, le SQL intégré est ce qu'il est - ce n'est pas moi qui décide).

J'ai décomposé sémantiquement les instructions SQL en plusieurs chaînes concaténées sur plusieurs lignes de code pour faciliter la maintenance. Ainsi, au lieu de quelque chose comme :

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

J'ai quelque chose comme :

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

Ce style rend le SQL beaucoup plus facile à lire et à maintenir (IMHO), en particulier pour les grandes requêtes. Par exemple, je peux mettre mon éditeur en mode "overwrite" et modifier le texte sur place assez facilement.

Notez que cette question dépasse l'exemple particulier de SQL. Tout code écrit avec un quelconque formatage vertical, en particulier les constructions tabulaires, est susceptible d'être détruit par une jolie imprimante.

Or, certains membres du projet utilisent l'éditeur Eclipse et le formatage sémantique est souvent détruit lorsqu'ils formatent un fichier source entier.

Existe-t-il un moyen de demander à Eclipse d'ignorer certaines lignes de source en ce qui concerne le formatage ?

Je cherche quelque chose comme un commentaire spécial qui permette d'activer le formateur Eclipse. Idéalement, un tel commentaire pourrait être configuré pour être ce que nous choisissons, et d'autres formateurs pourraient être programmés pour le respecter également :

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

Évidemment, une "solution" consiste à faire en sorte que les membres de notre équipe se standardisent sur un formateur externe tel que Jalopy ou JIndent mais ce n'est pas l'objet de cette question (et ce n'est pas non plus ma décision concernant ce projet) : Je cherche spécifiquement un moyen d'éviter le formateur Eclipse sur une base ad-hoc.

Idéalement, une solution me permettra d'insérer des instructions pour le formateur Eclipse sans que les membres de l'équipe utilisant Eclipse n'aient à reconfigurer l'IDE. (autre que le choix éventuel d'un commentaire de commande agnostique pour le formateur : STOP-ECLIPSE-FORMATTING → STOP-FORMATTING ).

Answer 1

Eclipse 3.6 vous permet de désactiver le formatage en plaçant un commentaire spécial, tel que

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

Les fonctions d'activation et de désactivation doivent être activées dans les préférences d'Eclipse : Java > Code Style > Formatter . Cliquez sur Edit , Off/On Tags , permettre Enable Off/On tags .

Il est également possible de changer les chaînes magiques dans les préférences - consultez la documentation d'Eclipse 3.6 ici .

Plus d'informations

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

Cette préférence vous permet de définir une balise pour désactiver et une balise pour activer le formateur (voir l'onglet Balises Off/On dans votre profil de formateur) :

Vous devez également activer les drapeaux de Java Formatting

Answer 2

AFAIK à partir d'Eclipse 3.5 M4 le formateur a une option "Never Join Lines" qui préserve les coupures de lignes de l'utilisateur. Peut-être cela fait-il ce que vous voulez.

Sinon, il y a cet affreux hack

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

Answer 3

Voir cette réponse sur SO .

Il existe une autre solution que vous pouvez utiliser pour supprimer le formatage de certains commentaires de bloc. Utilisez /*- (notez le trait d'union) au début du commentaire du bloc, et le formatage ne sera pas affecté si vous formatez le reste du fichier.

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

Source : Documentation chez Oracle .

Answer 4

Vous devez activer la possibilité d'ajouter les balises de formatage. Dans la barre de menu, allez dans :

Windows → Preferences Java → Code Style → Formatter

Appuyez sur le bouton Edit bouton. Choisissez le dernier onglet. Remarquez la case On/Off et activez-les avec une case à cocher.

Answer 5

Si vous mettez le signe plus au début de la ligne, le format est différent :

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