Заставить средство форматирования кода Java Eclipse игнорировать комментарии блоков

Обновите 2010, как указано OP и в этом ответе специальной строки // @formatter:off в Eclipse 3.6 достаточно.

Он не был доступен на время вопроса.

Исходный ответ: июнь 2009 г., Eclipse 3.4 / 3.5

С помощью Java Formatter (Windows > Preferences > Java > Code Style > Formatter) вы можете создать новый профиль Formatter.

На вкладке «Комментарии» (в eclipse3.5) вы можете убедиться, что в поле «Javadoc comment settings» снять флажок «Format HTML tags».
Также отметьте «Never join lines» в разделе «General settings».

Тогда ваш комментарий должен быть записан как:

/**
 * PSEUDOCODE
 * Read in user's string/paragraph
 * 
 * Three cases are possible:
 * <dl>
 *   <dt>Case 1: foobar</dt>
 *     <dd>        do case 1 things</dd>
 *   <dt>Case 2: fred hacker</dt>
 *     <dd>        do case 2 things</dd>
 *   <dt>Case 3: cowboyneal</dt>
 *     <dd>        do case 3 things</dd>
 * </dl>        
 * In all cases, do some other thing
 */

Примечание. Я сделал комментарий Javadoc, а не простой комментарий, так как считаю, что комментарий с таким большим количеством текста лучше разместить перед методом. Кроме того, разделы документации Javadoc имеют больше параметров форматирования, с которыми можно поиграть.
Если они находятся перед методом (истинная документация Javadoc), HTML-теги <dl>, <dt> и <dd> помогут правильно представить его в представлении Javadoc.

Есть еще одно решение, которое вы можете использовать для подавления форматирования определенных комментариев блока. Используйте /*- (обратите внимание на дефис) в начале комментария блока, и форматирование не изменится, если вы отформатируете остальную часть файла.

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

Источник: http://www.oracle.com/technetwork/java/javase/documentation/codeconventions-141999.html#350

Я только что узнал от коллеги, что Eclipse предлагает специальные теги форматирования, которые можно использовать для этого:

// @formatter:off
/*
 * ╔════════╦═══════╦══════════╗
 * ║ Month  ║ Sales ║ Position ║
 * ╠════════╬═══════╬══════════╣
 * ║ June   ║ 44k   ║ 2nd      ║
 * ║ July   ║ 39k   ║ 2nd      ║
 * ║ August ║ 49k   ║ 4th      ║
 * ╚════════╩═══════╩══════════╝
 *
 * This comment shouldn't be formatted, and will now be ignored by the formatter.
 */
// @formatter:on

Обратите внимание, что вам может потребоваться вручную включить эту функцию в меню «Настройки» Java> Стиль кода> Форматирование, нажав Изменить, выбрав вкладку Выкл. / Вкл. Теги и установив флажок Включить теги Off / On (исходный код).

Быстрый поиск в Google строки @formatter: off привел меня к другому ответу SO, который упомянул эту функцию в контексте отключения средства форматирования для блоков кода. Я подтвердил, что он работает для комментариев к строкам, «обычных» комментариев блока, а также комментариев блока Javadoc.

Другая возможность - использовать HTML-тег ‹pre> в Javadoc:

/**
 * <pre>
 *    this
 *   is
 *      kept
 *  as
 *    is
 * </pre>
 */

По крайней мере, так я стараюсь встраивать свой ASCII-арт в комментарии к исходному коду :)

Обведите конкретный текст тегами <pre> </pre>.

В Eclipse 3.4: Preferences, Java-> Code Style-> Formatter, затем отредактируйте профиль, вкладку комментариев. Там есть множество опций для управления форматированием комментариев.

Если вы хотите подавить форматирование в eclipse, вы всегда можете обернуть контент, предназначенный НЕ ДЛЯ ФОРМАТИРОВАНИЯ, в тег <pre>UNFORMATTED CONTENT</pre>. Программа форматирования Javadoc обнаружит этот тег и оставит все, что находится между этими тегами, неформатированным.

Плюсы:

• Остальная часть документации Javadoc все еще отформатирована
• HTML-вывод Javadoc также будет "неформатированным" из-за предварительных тегов.

Минусы:

• Не видя ни одного

один обходной путь - добавить тег pre для комментариев, которые вы не хотите форматировать в eclipse.

/**
 * <pre>
 *    this part
 *   is
 *      out of
 *  format
 *    
 * </pre>
 */

Попробуй это. Это сработало для меня. С помощью Java Formatter (Windows> Preferences> Java> Code Style> Formatter) вы можете создать новый профиль Formatter из существующего, а затем отредактировать его.

Если Eclipse не позволяет сохранить это, создайте новый и сохраните в нем.

Это зависит от языка.

Например, если вы работаете с javascript, вы должны перейти в «Окно -> Настройки -> Javascript -> Стиль кода -> Средство форматирования», а затем отредактировать параметры средства форматирования.

Изменить (с учетом изменений в OP Вопросы

Для редактирования форматирования кода Java перейдите в «Окно -> Настройки -> Java -> Стиль кода -> Форматирование».

Вверху панели вы увидите

Активный профиль:
Eclipse [встроенный]

Оттуда у вас будет одна кнопка справа, «Изменить», и две ниже, «Создать ...» и «Импортировать ...». Я бы порекомендовал отредактировать существующий профиль.

В диалоговом окне редактирования профиля есть несколько вкладок вверху. Последняя вкладка - «Комментарии». Чтобы полностью отключить форматирование комментария, снимите флажок «Включить форматирование комментария Javadoc», «Включить форматирование комментария блока», «Включить форматирование комментария строки» и «Включить форматирование комментария заголовка».

Вы можете изменить это в Windows - Preferences - Java - Code Style - Formatter, затем нажмите кнопку Edit .., найдите Комментарии, выберите Never Join Lines.

Тогда все должно быть в порядке.