格式化程序

在 Java 编辑器中,对代码按 Ctrl+Shift+F 以对其进行格式化。如果未设置任何选项,那么会格式化整个源代码,否则仅格式化所选内容。本章各段列示了使用格式化程序的一些技巧。

请注意,可在 打开“Java 格式化程序”首选项页 Java 格式化程序首选项页上访问 Java 格式化程序首选项。

在各个部分内禁用格式化程序

可在代码的一个或多个部分中禁用/启用格式化程序,如以下样本中所示:

Java 格式化程序示例。使用禁用和启用标记的一些代码。

以上片段使用缺省标记名称,但可在“Java 格式化程序”首选项页面的禁用/启用标记选项卡上更改这些名称。

回绕最外部的方法调用

从版本 3.6 开始,Java 格式化程序现在先尝试回绕最外面的方法调用以便在回绕嵌套方法时产生更好的输出。

以下是格式化代码的示例,在该位置,格式化程序回绕最外面的消息调用的参数之间的行以使每个嵌套方法调用在单独的行上:

Java 格式化程序示例。带有格式化嵌套方法调用的简单片段。

新的首选项允许您禁用此新策略,通常来说,如果您想要像以前一样对代码进行格式化,请取消选择可在“Java 格式化程序”首选项页面的自动换行选项卡上可访问的愿意回绕外部表达式首选项。

注意:目前新策略仅应用于嵌套方法调用,但在将来版本可能扩展至其他嵌套表达式。

压缩 Javadoc 和块注释

用户可减少格式化多行注释的行数,如以下示例所示:

Java 格式化程序示例。块和 Javadoc 注释格式所占行数较少(与缺省概要文件相比)的简单片段。

要激活此行为,请取消选择在“Java 格式化程序”首选项页的注释选项卡上可访问的 /* 和 */ 在不同行上首选项。

同种类的首选项也对 Javadoc 注释可用。

保留用户换行符

用户可通过不在代码或注释中连接行来保留换行符。

例如,以下测试用例中 return 语句的已回绕行:

要格式化的代码的示例

在使用从不连接行首选项时将由格式化程序保留,因此格式化时会产生以下输出:

使用“从不连接行”时格式化的代码

要激活此行为,请选择“Java 格式化程序”首选项页的自动换行和注释选项卡上可访问的从不连接行首选项。

相关概念

Java 编辑器
Java 开发工具 (JDT)

相关参考

“编辑”菜单
Java 编辑器首选项
格式化程序首选项