如何关闭Java代码某些部分的Eclipse代码格式化程序？

我有一些Java代码，其中的SQL语句编写为Java字符串（请不要使用OR / M烈火，嵌入式SQL就是它-不是我的决定）。

为了简化维护，我将SQL语句从语义上分成了几行代码，并由几行代码组成。因此，而不是像这样：

String query = "SELECT FOO, BAR, BAZ FROM ABC WHERE BAR > 4";

我有类似的东西：

String query =
    "SELECT FOO, BAR, BAZ" +
    "  FROM ABC          " +
    " WHERE BAR > 4      ";

这种样式使SQL更易于阅读和维护（IMHO），尤其是对于较大的查询。例如，我可以将编辑器置于“覆盖”模式并相当容易地就地修改文本。

请注意，此问题超出了SQL的特定示例的范围。用任何垂直格式编写的任何代码，特别是表格结构，都容易被漂亮的打印机破坏。

现在，一些项目成员使用Eclipse编辑器，并且在格式化整个源文件时常常会破坏语义格式。

有没有一种方法可以指示Eclipse在格式化方面忽略某些源代码行？

我正在寻找类似特殊注释的东西，以切换Eclipse格式化程序。理想情况下，这样的注释可以配置为我们选择的任何内容，并且其他格式化程序也可以编程为尊重它：

// STOP-ECLIPSE-FORMATTING
String query =
    "SELECT FOO, BAR, BAZ" +
    "  FROM ABC          " +
    " WHERE BAR > 4      ";
// START-ECLIPSE-FORMATTING

显然，“解决方案”是让我们的团队成员标准化一些外部格式化程序，例如Jalopy或JIndent，但这不是这个问题的目的（也是我对这个项目的决定）：我正在寻找一种方法来临时避免使用Eclipse格式化程序。

理想情况下，一种解决方案将允许我插入Eclipse格式化程序的说明，而无需使用Eclipse的团队成员进行任何IDE重新配置（除了可能选择与格式化程序无关的命令注释：STOP-ECLIPSE-FORMATTING→ STOP-FORMATTING）。

Eclipse 3.6允许您通过放置特殊注释来关闭格式，例如

// @formatter:off
...
// @formatter:on

必须在Eclipse首选项中将“打开/关闭”功能“打开” Java > Code Style > Formatter。点击Edit，Off/On Tags使能Enable Off/On tags。

也可以在首选项中更改魔术字符串- 在此处查看Eclipse 3.6文档。

更多信息

Java > Code Style > Formatter > Edit > Off/On Tags

此首选项允许您定义一个禁用标签和一个启用格式化程序的标签（请参阅格式化程序配置文件中的“关闭/打开标签”选项卡）：

您还需要启用来自 Java Formatting

格式化程序上的Eclipse 3.5 M4的AFAIK具有选项“从不连接线”，它保留用户换行符。也许这就是您想要的。

否则会有这个丑陋的骇客

String query = //
    "SELECT FOO, BAR, BAZ" + //
    "  FROM ABC"           + //
    " WHERE BAR > 4";

在SO上看到这个答案。

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

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

资料来源：Oracle文档。

您可以将其配置为不连接已经换行的行，而不是关闭格式。与Jitter的响应类似，这是针对Eclipse STS的：

属性→Java代码样式→格式化程序→启用项目特定设置或配置工作区设置→编辑→换行（选项卡）→选中“从不加入已换行的行”

保存，申请。

您必须启用添加格式标记的功能。在菜单栏中转到：

Windows → Preferences Java → Code Style → Formatter

按下Edit按钮。选择最后一个标签。注意“打开/关闭”框，并通过复选框启用它们。

如果将加号放在行首，则格式会有所不同：

String query = 
    "SELECT FOO, BAR, BAZ" 
    +    "  FROM ABC"           
    +    " WHERE BAR > 4";

我正在使用固定宽度的字符串部分（用空格填充），以避免格式化程序弄乱我的SQL字符串缩进。这会给您带来混合的结果，并且在空白不能像在SQL中那样被忽略的情况下将无法使用，但是会有所帮助。

    final String sql = "SELECT v.value FROM properties p               "
            + "JOIN property_values v ON p.property_id = v.property_id "
            + "WHERE p.product_id = ?                                  "
            + "AND v.value        IS NOT NULL                          ";

每行末尾都有一个双斜杠“ //”。这样可以防止Eclipse将它们全部移到同一行。

替代方法：在Eclipse 3.6中，在“换行”下然后在“常规设置”下，有一个选项“从不连接已经换行的行”。这意味着格式化程序将包装长行，但不会撤消任何已有的包装。

@xpmatteo可以禁用部分代码，但是除此之外，默认的eclipse设置应该设置为仅格式化已编辑的代码行，而不是整个文件。

Preferences->Java->Editor->Save Actions->Format Source Code->Format Edited Lines

因为您的同事正在重新格式化他们实际上没有更改的代码，所以这首先可以防止它发生。这是一个很好的做法，可以防止使源代码控件上的差异变得无用的麻烦（当由于格式设置的微小差异而重新格式化整个文件时）。

如果关闭了开/关标签选项，这也将阻止重新格式化。

幻影注释，添加//您想要的新行的地方，很棒！

1. @formatter：off将代码中的引用添加到编辑器。我认为该代码不应包含此类引用。

2. 不管使用哪种格式化工具，幻像注释（//）都可以使用。不管是Eclipse还是InteliJ或您使用的任何编辑器。这甚至可以与非常不错的Google Java格式一起使用

3. 幻影注释（//）将在整个应用程序中正常工作。如果您也有Javascript，也许使用JSBeautifier之类的东西。您也可以在Javascript中使用类似的代码样式。

4. 实际上，您可能确实想正确格式化吗？您要删除混合的制表符/空格和尾随空格。您要根据代码标准缩进行。您不想要的是长队。那就是幻象评论给您的！

这个hack的作品：

String x = "s" + //Formatter Hack
    "a" + //
    "c" + //
    "d";

我建议不要使用格式化程序。错误的代码应该看起来不好而不是人为地好。好的代码需要时间。您不能欺骗质量。格式化是源代码质量的一部分。