使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>首选项> Java>代码样式>格式设置，但是找不到用于保留注释格式的设置。我正在使用Eclipse 3.4.0。

更新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视图中正确地呈现它。

您可以使用另一种解决方案来禁止特定块注释的格式。/*-在块注释的开头使用（注意连字符），如果格式化文件的其余部分，则格式不会受到影响。

/ *-
 *这是一个带有一些非常特殊的注释
 *我希望缩进（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>代码样式>格式器，单击“编辑”，选择“关闭/打开标签”选项卡，然后选中“启用关闭/打开标签（源）”来手动启用此功能。

对字符串@formatter：off的快速Google搜索使我想到了另一个SO答案，它在禁用代码块格式化程序的上下文中提到了此功能。我已经确认它适用于行注释，“常规”块注释和Javadoc块注释。

另一种可能性是在Javadoc中使用HTML的<pre>：

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

至少这就是我倾向于将ASCII艺术嵌入到源代码注释中的方式:)

用<pre> </pre>标签将特定文本括起来。

在Eclipse 3.4：“偏好设置”中，单击Java->代码样式->格式化程序，然后编辑配置文件，注释选项卡。那里有很多用于控制注释格式的选项。

如果要抑制eclipse中的格式，则始终可以将旨在避免被格式化的内容包装到<pre>UNFORMATTED CONTENT</pre>标记中。Javadoc格式化程序将检测到该标签，并使该标签之间的所有内容保持未格式化状态。

优点：

• 其余的Javadoc仍被格式化
• 由于前置标记，Javadoc的html输出也将“未格式化”

缺点：

• 没有看到一个

一种解决方法是为您不希望Eclipse格式化的注释添加预标记

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

试试这个。这对我有用。使用Java格式化程序（Windows>首选项> Java>代码样式>格式化程序），可以从现有的格式化程序配置文件创建一个新的格式化程序配置文件，然后对其进行编辑。

如果Eclipse不允许保存它，则创建一个新文件并保存。

它取决于语言。

例如，如果使用javascript，则应转到“窗口->首选项-> Javascript->代码样式->格式化程序”，然后编辑格式化程序选项。

编辑（反映OP问题中的更改

要编辑Java代码格式，请转到“窗口->首选项-> Java->代码样式->格式化程序”

在面板顶部，您将看到

活动配置文件：
Eclipse [内置]

从那里有一个右边的按钮，“编辑”，以及下面的两个按钮，“新建...”和“导入...”。我建议编辑现有的配置文件。

在编辑配置文件对话框中，顶部有一系列选项卡。最后一个标签是“评论”。要完全禁用注释格式，请取消选中“启用Javadoc注释格式”，“启用块注释格式”，“启用行注释格式”和“启用标题注释格式”。

您可以在Windows-首选项-Java-代码样式-格式器中进行更改，而不是单击“编辑..”按钮，找到“注释”，然后选择“从不合并行”。

然后，应该没问题。