Як вимкнути формат коду Eclipse для певних розділів коду Java?

У мене є якийсь код Java з операторами SQL, написаний у вигляді рядків Java (будь-ласка, не FO / M flamewars; вбудований 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

Очевидно, що одне "рішення" полягає в тому, щоб члени нашої команди стандартизували зовнішній формат, наприклад, Jalopy або JIndent , але це не про це питання (також, не моє рішення щодо цього проекту): я спеціально шукаю спосіб уникайте форматів Eclipse на спеціальній основі.

В ідеалі рішення дозволить мені вставити інструкції для форматора Eclipse, не вимагаючи від членів команди, що використовують Eclipse, робити будь-яку переконфігурацію IDE (окрім можливого вибору коментаря агностичної команди відформатора: 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.

Також можна змінити магічні рядки в налаштуваннях - ознайомтеся з документами Eclipse 3.6 тут .

Більше інформації

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

Цей параметр дозволяє визначити один тег для відключення та один тег для активації форматера (див. Вкладку Вимкнено / Увімкнено Теги у профілі форматера):

Вам також потрібно включити прапори з Java Formatting

AFAIK від Eclipse 3.5 M4 на форматері має опцію "Ніколи не приєднуйтесь до ліній", яка зберігає розриви користувачів. Можливо, це робить те, що ти хочеш.

Ще там є цей некрасивий злом

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

Дивіться цю відповідь на ТАК .

Є ще одне рішення, яке можна використовувати для придушення форматування конкретних блокових коментарів. Використовуйте /*-(зверніть увагу на дефіс) на початку коментаря до блоку, і на форматування це не вплине, якщо ви форматуєте решту файлу.

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

Джерело: Документація в Oracle .

Замість того, щоб вимикати форматування, ви можете налаштувати його не приєднуватися до вже завернутих рядків. Подібно до відповіді Джиттера, ось для 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 має відповідь на відключення частин коду, але крім цього, параметри затемнення за замовчуванням повинні бути встановлені лише у форматі редагованих рядків коду замість усього файлу.

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

Це завадило б це в першу чергу, оскільки ваші колеги переформатують код, який вони насправді не змінили. Це хороша практика для запобігання випадковим випадкам, які роблять різницю у вашому контролі джерела марною (коли весь файл переформатується через незначні відмінності в налаштуваннях формату).

Це також запобіжить переформатування, якщо параметр тегів увімкнення / вимкнення буде вимкнено.

Зауваження фантома, додавши, //де вам потрібні нові рядки, чудові!

1. @Formatter: off додає в редактор посилання з коду. На мій погляд, код не повинен мати таких посилань.

2. Примітки фантома (//) працюватимуть незалежно від використовуваного інструменту форматування. Незалежно від Eclipse або InteliJ або будь-якого редактора, який ви використовуєте. Це навіть працює з дуже приємним форматом Java Java

3. Примітки фантома (//) працюватимуть у вашій програмі. Якщо у вас також є Javascript і можливо, використовуйте щось на зразок JSBeautifier . Ви можете мати подібний стиль коду також у Javascript.

4. Насправді ви, напевно, хочете форматування правильно? Ви хочете видалити змішані пробіли / пробіли та пробіли. Рядки потрібно відступити відповідно до стандарту коду. Чого ти не хочеш - це довга черга. Це, і тільки це, те, що дає коментар фантома!

Цей хак працює:

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

Я б запропонував не використовувати форматер. Поганий код повинен виглядати погано, а не штучно добре. Хороший код вимагає часу. Ви не можете обдурити якість. Форматування є частиною якості вихідного коду.