Примушуючи програмоутворювач коду Java Eclipse ігнорувати коментарі блоків

Чи є спосіб змусити вбудований в 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.

Оновлення 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.

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

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

Джерело: 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> Code Style> Formatter, натиснувши на Edit , вибравши Off / On Мітки вкладку і перевірка Enable Off / On тегів ( джерела ).

Швидкий Google для рядка @formatter: off підвів мене до цієї іншої відповіді SO , яка згадала цю функцію в контексті вимкнення форматування для блоків коду. Я підтвердив, що це працює для коментарів рядків, "звичайних" коментарів блоків та коментарів блоків Javadoc.

Інша можливість - використовувати HTML-код <pre> у Javadoc:

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

Принаймні так я схильний вбудовувати своє ASCII-мистецтво в коментарі до вихідного коду :)

Оточіть певний текст <pre> </pre>тегами.

В Eclipse 3.4: Налаштування, Java-> Стиль коду-> Форматтер, потім відредагуйте профіль, вкладку коментарів. Там є безліч варіантів для контролю форматування коментарів.

Якщо ви хочете придушити форматування в eclipse, ви завжди можете обернути вміст, який НЕ ФОРМУЄТЬСЯ, у <pre>UNFORMATTED CONTENT</pre>тег. Форматизатор Javadoc виявить цей тег і залишить все між цими тегами неформатованим.

Плюси:

• Решта Javadoc все ще відформатована
• Висновок HTML Javadoc також буде "неформатованим" через попередні теги

Мінуси:

• Не бачачи жодного

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

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

Спробуйте це. Це спрацювало для мене. За допомогою Java Formatter (Windows> Налаштування> Java> Стиль коду> Formatter) ви можете створити новий профіль Formatter із існуючого, а потім відредагувати його.

Якщо Eclipse не дозволяє зберегти це, створіть новий і збережіть у ньому.

Це залежить від мови.

Наприклад, якщо ви працюєте з javascript, вам слід перейти до "Вікно -> Налаштування -> Javascript -> Стиль коду -> Форматтер", а потім відредагувати параметри форматування.

Редагувати (відображаючи зміни у запитаннях до ОП

Для редагування форматування коду Java перейдіть до "Вікно -> Налаштування -> Java -> Стиль коду -> Форматтер"

У верхній частині панелі ви побачите

Активний профіль:
Eclipse [вбудований]

Звідти у вас одна кнопка праворуч, "Редагувати", а дві нижче, "Створити ..." та "Імпортувати ...". Я б порекомендував редагувати існуючий профіль.

У діалоговому вікні редагування профілю вгорі є ряд вкладок. Остання вкладка - "Коментарі". Щоб повністю вимкнути форматування коментарів, зніміть прапорець «Увімкнути форматування коментарів Javadoc», «Увімкнути блокування форматування коментарів», «Увімкнути форматування рядків коментарів» та «Увімкнути форматування коментарів заголовка».

Ви можете змінити це в Windows - Налаштування - Java - Стиль коду - Formatter, після чого натисніть кнопку Редагувати .., знайдіть Коментарі, виберіть Ніколи не приєднуватися до рядків.

Тоді це повинно бути нормально.