Заставить Eclipse-кодировщик кода Java игнорировать комментарии к блоку

Question

Есть ли способ заставить встроенный в Eclipse форматировщик кода Java игнорировать комментарии? Всякий раз, когда я запускаю его, получается так:

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

в это:

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

Я уже поиграл с Windows> «Настройки»> «Java»> «Стиль кода»> «Параметры форматирования», но не могу найти его для сохранения форматирования комментариев. Я использую Eclipse 3.4.0.

Answer 1

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

/*-
 * 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

Answer 2

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

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

---

Оригинальный ответ: июнь 2009 г., Затмение 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.

Answer 3

Я только что узнал от коллеги, что 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

Обратите внимание, что вам может потребоваться вручную включить эту функцию через меню настроек & rarr; Java> Code Style> Formatter, нажав Изменить , выбрав вкладку Выкл. / Вкл. и отметив Включить теги Выкл. / Вкл. ( источник ).

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

Answer 4

Другая возможность - использовать HTML

in Javadoc:</p>

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

. * /

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

Answer 5

Окружите определенный текст тегами .

Answer 6

В Eclipse 3.4: «Настройки», «Java» -> «Стиль кода» -> «Форматтер», затем редактируйте профиль, вкладку «Комментарии». Там есть несколько вариантов управления форматированием комментариев.

Answer 7

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

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

* /

Answer 8

Если вы хотите подавить форматирование в Eclipse, вы всегда можете заключить содержимое, которое НЕ БУДЕТ ФОРМАТИРОВАТЬ в тег UNFORMATTED CONTENT. Javadoc formatter обнаружит этот тег и оставит все, что находится между этими тегами, неотформатированным.

Плюсы:

• Остальная часть Javadoc все еще отформатирована
• Вывод havml в Javadoc также будет «неформатированным» из-за предварительных тегов

Минусы:

• Не видел никого

Answer 9

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

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

Answer 10

Вы можете изменить это в Windows - Настройки - Java - Стиль кода - Форматтер, чем нажать кнопку Изменить .., найти комментарии, выберите Никогда не присоединяйтесь к линиям.

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