如何使用注释禁用代码的某些部分的代码格式？

Question

我想像 Eclipse中那样有选择地禁用IntelliJ IDEA代码格式化程序以获取部分代码.IntelliJ是否支持此功能,如果支持,我该如何使用它？

Answer 1

从版本13开始,可以使用包装代码

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

在2016.x版中,在Preferences> Editor> Code Style中启用它.(谢谢菲利普)

在版本2018.x中,在文件>设置>编辑器>代码样式中启用它(您可以更改格式化程序控件标记,只要它们在注释中).

在版本14中,在首选项>编辑器>代码样式>格式化程序控件 (感谢Emerson Farrugia)中启用它

你必须转到`Preferences`->`Code Style`->`General`->`Formatter Control`并检查`在注释中启用格式化程序标记'才能生效. (78认同)
在14中,这是在首选项>编辑器>代码样式>格式化程序控件 (13认同)
为什么默认情况下禁用此选项？将标记放在代码中并限制整个团队的格式似乎非常有用. (6认同)
在2016.x版本中,可以在"设置">"编辑器">"代码样式"中找到它. (3认同)
目前，`@formatter:on`（或您定义的任何内容）不会执行任何操作，除非 `@formatter:off` 已经存在。可能还有其他方法可以关闭重新格式化——或者让编辑器不自动重新格式化您的代码。搜索您的偏好。例如，此设置用于控制在手动执行“重新格式化”时不应重新格式化的部分。 (2认同)
@TimurYarosh 在 Intellij IDEA youtrack 中有一张票，请随意投票，也许 Jetbrains 最终会实现它：https://youtrack.jetbrains.com/issue/IDEA-118043 (2认同)

Answer 2

请注意,对于Carlos的回答@formatter:off和@formatter:on工作,您可能需要首先启用首选项:

在IntelliJ首选项中,在代码样式,常规,格式化程序控件下,有一个复选框

IDEA-56995使用注释禁用每个区域的代码格式

我想在整个项目中禁用它 (7认同)
搜索"重新格式化"的首选项以查看IntelliJ自动重新格式化代码的几种方式的复选框:粘贴时,键入右括号,来自模板...如果要更改功能,可以真正深入了解.并不总是有意义的.如果提出问题,请使用IntelliJ的支持,或者如果提出建议,请使用他们的错误跟踪器. (4认同)

Answer 3

在xml文件中使用:

<!-- @formatter:off -->
<!-- @formatter:on -->

Answer 4

2010年的过时答案:

不,现在不可能,我已经提交了一个你可以跟踪的新问题.

作为临时解决方案,您可以使用IDEA的外部格式化程序插件,该插件可以使用Eclipse代码格式化程序(我没有检查是否支持此特定选项).