web-dev-qa-db-ja.com

EclipseのJavaコードフォーマッターがブロックコメントを無視するようにする

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> Preferences> Java> Code Style> Formatterの設定で遊んでいますが、コメントのフォーマットを維持するための設定が見つかりません。Eclipse3.4.0を使用しています。

75
Pops

2010を更新します。 OPが指す および この回答では 、特別な文字列// @formatter:off Eclipse 3.6で十分です。

利用できませんでした 質問の時点で。


元の回答:2009年6月 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ビュー内で適切に表示するのに役立ちます。

36
VonC

特定のブロックコメントのフォーマットを抑制するために使用できる別のソリューションがあります。使用する /*-(ハイフンに注意)ブロックコメントの先頭にあり、ファイルの残りの部分をフォーマットする場合、フォーマットは影響を受けません。

/*-
 *非常に特殊な
 *インデント(1)で無視したいフォーマットのブロックコメントです。
 * 
 *    一二三
 */

ソース: http://www.Oracle.com/technetwork/Java/javase/documentation/codeconventions-141999.html#35

172
Michelle Crane

同僚から、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、click onEditオフ/オンタグタブを選択し、オフ/オンタグを有効にするソース )。

文字列@ formatter:offの簡単なGoogleが this other SO answer =、コードブロックのフォーマッタを無効にするコンテキストでこの機能について言及しましたが、行コメント、「通常の」ブロックコメント、およびJavadocブロックコメントでも機能することを確認しました。

23
Pops

別の可能性は、JavadocでHTMLの<pre>を使用することです。

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

少なくともこれは、ソースコードのコメントにASCIIアートを埋め込む傾向があります:)

16
Thomas Keller

特定のテキストを<pre> </pre>タグで囲みます。

8
Philip

Eclipse 3.4の場合:[設定]、[Java]-> [コードスタイル]-> [フォーマッター]、[プロファイルの編集]、[コメント]タブ。コメントのフォーマットを制御するためのオプションがたくさんあります。

2
skaffman

回避策の1つは、Eclipseでフォーマットしたくないコメントにpreタグを追加することです

/**
 * <pre>
 *    this part
 *   is
 *      out of
 *  format
 *    
 * </pre>
 */
1
K. Andy wang

Eclipseでフォーマットを抑制したい場合は、<pre>UNFORMATTED CONTENT</pre>タグにフォーマットされないように意図されたコンテンツをいつでもラップできます。 Javadocフォーマッタはそのタグを検出します、そのタグ間のすべてを未フォーマットのままにします。

長所:

  • Javadocの残りはまだフォーマットされています
  • JavadocのHTML出力は、事前タグのために「フォーマットされていない」ものになります

短所:

  • 見えない
1
Antoniossss

これは、Windows-環境設定-Java-コードスタイル-フォーマッタ、[編集]ボタンをクリックするよりも変更できます。

その後、それは問題ないはずです。

0
GH Dev

言語依存です。

たとえば、javascriptを使用している場合、「ウィンドウ->設定-> Javascript->コードスタイル->フォーマッタ」に進み、フォーマッタオプションを編集します。

編集(OP質問の変更を反映

Javaコードの書式設定を編集するには、[ウィンドウ->設定-> Java->コードスタイル->フォーマッタ]に移動します

パネルの上部に表示されます

アクティブなプロファイル:
Eclipse [ビルトイン]

そこから右側に「編集」ボタンが1つ、下に「新規...」と「インポート...」の2つのボタンがあります。既存のプロファイルを編集することをお勧めします。

[プロファイルの編集]ダイアログには、上部に一連のタブがあります。最後のタブは「コメント」です。コメントフォーマットを完全に無効にするには、「Javadocコメントフォーマットを有効にする」、「ブロックコメントフォーマットを有効にする」、「行コメントフォーマットを有効にする」、「ヘッダーコメントフォーマットを有効にする」のチェックを外します。

0

これを試してください。これは私のために働いた。 Java Formatter(Windows> Preferences> Java> Code Style> Formatter))を使用すると、既存から新しいFormatterプロファイルを作成して編集できます。

Eclipseでこれを保存できない場合は、新しいものを作成して保存します。 enter image description here

0
Milan Kamboya