Herstellung von Eclipse Java Code Formatter ignorieren Block Kommentare

Question

Gibt es eine Möglichkeit Eclipse integrierten Java-Code Formatter Kommentare ignorieren zu machen? Jedes Mal, wenn ich es laufen, es stellt sich folgendermaßen aus:

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

in diesen:

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

Ich habe bereits um die Fenster> Einstellungen> Java> Code-Style> Formatter Einstellungen gespielt, aber man kann nicht für die Aufbewahrung Kommentar Formatierung finden. Ich bin mit Eclipse 3.4.0.

Answer 1

Update 2010, als durch die OP und in dieser Antwort , 3.6 die spezielle String // @formatter:off in Eclipse ist genug.

Es war nicht verfügbar zum Zeitpunkt der Anfrage.

---

Original Antwort: Juni 2009 3.4 / 3.5 Eclipse-

Mit dem Java Formatter (Windows > Preferences > Java > Code Style > Formatter), können Sie ein neues Formatter Profil erstellen.

In der Registerkarte Comments (in eclipse3.5), können Sie sicher machen, in den "Javadoc comment settings" deaktivieren "Format HTML tags".
Prüfen Sie auch die "Never join lines" im "General settings" Abschnitt.

Dann wird Ihr Kommentar sollte wie folgt geschrieben werden:

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

Hinweis: Ich habe eine Javadoc Kommentar, und nicht eine einfache Bemerkung gemacht, als ich ein Kommentar mit so viel Text daran glauben besser vor einem Verfahren platziert werden kann. Außerdem Javadoc Abschnitte haben mehr Formatierungsparameter zu spielen.
Wenn es vor einem Verfahren (true Javadoc) ist, die HTML-Tags <dl>, <dt> und <dd> hilft es richtig in der Javadoc Ansicht zu präsentieren.

Answer 2

Es gibt eine andere Lösung, die Sie die Formatierung von spezifischen Block Kommentare zu unterdrücken können. Verwenden Sie /*- (man beachte den Bindestrich) zu Beginn des Blocks Kommentar, und die Formatierung nicht betroffen sein werden, wenn Sie den Rest der Datei formatiert werden.

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

Quelle: http://www.oracle. com / TechNetwork / java / JavaSE / Dokumentation / codeconventions-141999.html # 350

Answer 3

Ich bin gerade von einem Kollegen gelernt, die Eclipse-Spezial-Formatierungs-Tags bietet, die dafür verwendet werden kann:

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

Beachten Sie, dass Sie manuell benötigen → Java> Code-Style> Formatter, klicken Sie auf Bearbeiten , die Auswahl der Aus / Ein Tags diese Funktion durch das Menü Einstellungen aktivieren und Überprüfung Aktivieren Off / On-Tags ( Quelle ).

Eine schnelle Google für die Zeichenfolge @formatter: off hat mich href="https://stackoverflow.com/a/3353765/122607"> diese andere SO beantworten , die diese Funktion im Zusammenhang mit der Deaktivierung der Formatierer für Codeblöcke erwähnt. Ich habe bestätigt, dass es für die Inline-Kommentare, „normal“ Block Kommentare und Javadoc Block Kommentare als gut funktioniert.

Answer 4

Eine andere Möglichkeit ist die Verwendung HTML des

 in Javadoc: 


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


 Mindestens das ist, wie ich neige dazu, meine ASCII-Kunst im Quellcode Kommentar einbetten:) 
	

Answer 5

umgibt den spezifischen Text mit <pre> </pre> Tags.

Answer 6

in Eclipse 3.4: Einstellungen, Java-> Code-Stil-> Formatter, bearbeiten dann Profil, Kommentare Registerkarte. Es gibt eine Reihe von Möglichkeiten gibt zum Steuern Kommentar Formatierung.

Answer 7

Wenn Sie die Formatierung in Eclipse zu unterdrücken möchten, können Sie immer Inhalt wickeln, die dazu bestimmt ist, nicht in <pre>UNFORMATTED CONTENT</pre> Tag FORMATIERT ZU. Javadoc Formatierer wird den Tag erkennen und lassen Sie alles zwischen dem unformatierten Tags.

Vorteile:

• Rest von Javadoc ist noch formatiert
• Javadoc der HTML-Ausgabe wird "unformatiert" als auch wegen der Pre-Tags
sein

Nachteile:

• Nicht zu sehen, ein

Answer 8

Eine Abhilfe ist, hinzufügen pre Tag für die Kommentare, die Sie Eclipse

formatiert werden nicht wollen,

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

Answer 9

Es ist sprachabhängig.

Wenn zum Beispiel mit JavaScript arbeiten, Sie gehen würden "Fenster -> Einstellungen -> Javascript -> Code-Style -> Formatter". Und dann das Formatierungsprogramm Optionen bearbeiten

Bearbeiten (reflektierende OP Fragen changesin

Für Java-Code-Formatierung bearbeiten, gehen Sie zu "Fenster -> Einstellungen -> Java -> Code-Style -> Formatter"

Am oberen Rand des Fensters sehen Sie

  

Aktiv Profil:
  Eclipse [Built-in]

Von dort haben Sie einen Knopf auf der rechten Seite, „Bearbeiten“, und zwei unten, „New ...“ und „Import ...“. Ich würde empfehlen, das vorhandene Profil bearbeiten.

Im Profil bearbeiten Dialog gibt es eine Reihe von Registerkarten am oberen Rand. Der letzte Registerkarte „Kommentare“. Um vollständig zu deaktivieren Kommentar Formatierung, deaktivieren Sie „Enable Javadoc-Kommentar Formatierung“, „Bausteinkommentar aktiviert Formatierung“, „Zeilenkommentar aktiviert Formatierung“ und „Header-Kommentar aktivieren Formatierung“.

Answer 10

Sie können dies ändern, in Windows - Einstellungen - Java - Code-Stil - Formatter, als die Edit .. Schaltfläche klicken, finden Kommentare, wählen Sie für die Linien bei.

Dann sollte es in Ordnung sein.

Answer 11

Versuchen Sie dieses. Das funktionierte für mich. Mit dem Java Formatter (Windows> Einstellungen> Java> Code-Style> Formatter), können Sie ein neues Profil erstellen Formatter von bestehenden und dann bearbeiten.

Wenn Eclipse-nicht erlaubt, dies zu speichern dann einen neuen erstellen und dass speichern.