IntelliJ IDEA 2025.2 Help

重新设置代码格式

IntelliJ IDEA 允许您根据当前 代码样式方案.editorconfig 文件中指定的要求重新格式化代码。 如果在 .editorconfig 未定义任何内容,则将从项目设置中获取。

您可以重新格式化部分代码、整个文件、一组文件、一个目录和一个模块。 您还可以从重新格式化中排除部分代码或某些文件。

格式化代码片段

  1. 在编辑器中选择您要重新格式化的代码片段。

    在重新格式化之前,您可以查看应用于所选代码的代码样式设置:按 Alt+Enter 并点击 调整代码样式设置

  2. 在主菜单中,前往 代码 | 重新设置代码格式 或按 Ctrl+Alt+L

    或者,在显示的 工具栏上点击 重新设置代码格式

重新格式化文件

  1. 您可以在编辑器中打开文件并按 Ctrl+Alt+Shift+L ,或者在 项目 工具窗口中右键点击文件并选择 重新设置代码格式

  2. 在打开的 重新格式化文件 对话框中,您可以根据需要选择以下重新格式化选项:

    • 优化import(O) :如果您希望删除未使用的导入、添加缺失的导入或整理导入语句,请选择此选项。

      有关更多信息,请参阅 优化导入 部分。

    • 重新排序条目(R) :如果您需要根据代码样式设置中指定的 排列规则 重新排列代码,请选择此选项。

    • 代码清理 :选择此选项以运行代码清理检查。

    • 不保留换行符(B) :根据代码样式设置重新格式化换行符。 此选项将重写 重新设置格式时保持 | 换行符 设置。

  3. 点击 运行

    文件重格式化对话框

    如果您想查看代码在重新格式化期间所做的确切更改,请使用 本地历史记录 功能。

重新格式化模块或目录

  1. 项目 工具窗口中,右键点击模块或目录并选择 重新设置代码格式 或按 Ctrl+Alt+L

  2. 在打开的对话框中,指定 重新设置格式的选项

    您还可以对代码重新格式化应用过滤器,例如指定 范围 或将重新格式化范围缩小到特定文件类型。

    模块或目录重格式化对话框

重新格式化行缩进

您可以根据指定的设置重新格式化行缩进。

  1. 在编辑器中,选择必要的代码片段并按 Ctrl+Alt+I

  2. 如果您需要调整缩进设置,请在 设置 对话框(Ctrl+Alt+S )中,转到 编辑器 | 代码样式。 选择您要更改缩进的语言。

  3. 制表符和缩进 选项卡上,指定适当的缩进选项,然后点击 OK

保存时自动重新格式化代码

您可以配置 IDE,在修改文件的代码在更改 保存时自动重新格式化。

  1. Ctrl+Alt+S 打开设置,然后选择 工具 | 保存时的操作

  2. 启用 重新设置代码格式 选项。

  3. 此外,您可以配置 IDE 重新格式化代码的方式:

    • 点击 配置作用域… 以指定您要 排除在重新格式化之外的文件名和目录的模式。

    • 所有文件类型 列表中选择您要重新格式化代码的文件类型。

    • 如果您的项目在版本控制中,请选择 整个文件更改的行

      如果您选择 更改的行 ,代码重格式化将仅适用于本地更改但尚未提交到存储库的代码行。

在提交时重新格式化代码

如果您的项目在 版本控制下,您可以在提交更改到存储库时自动重新格式化代码。 在这种情况下,仅会重新格式化新增或修改的代码。

  1. Alt+0 打开 提交 工具窗口,然后点击 显示提交选项 设置按钮

  2. 提交检查 菜单下,启用 重新设置代码格式 选项。

启用该选项后,每次提交时,新增或修改的代码都会被重新格式化。

在提交时重新格式化代码

从命令行重新格式化代码

IntelliJ IDEA 可以从命令行将您的代码样式格式应用于指定的文件。

  1. 请确保您拥有适用于操作系统的命令行启动器。

  2. 运行 format 命令。

了解更多 从命令行格式化文件

排除文件格式化

您可以从重新格式化、 代码排列导入优化中排除一组文件和目录。

  1. 设置 对话框(Ctrl+Alt+S )中,前往 编辑器 | 代码样式

  2. 切换到 格式化程序 选项卡,在 不设置格式 字段中,使用 glob 模式输入您想要排除的文件和目录。

    您可以指定用分号 ; 分隔的几个通配符模式。 如果您点击 展开图标 ,该字段将展开,每个模式将显示在单独的行上。

  3. 应用更改并关闭对话框。

    指定一个 glob 模式以排除文件格式化

在编辑器中排除代码片段的重格式化

  1. 设置 对话框(Ctrl+Alt+S )中,前往 编辑器 | 代码样式

  2. 切换到 格式化程序 标签并启用 在代码注释中使用标记打开/关闭格式化程序 选项。

  3. 在编辑器中,您希望排除的区域开头创建行注释 Ctrl+/ 并输入 @formatter:off。 在该区域的末尾,创建另一行注释并输入 @formatter :on

    标记之间的代码不会重新格式化。

    格式标记

使用格式化标记的示例

保持现有格式

您可以选择在重新格式化代码时被忽略的格式化规则。 例如,您可以调整 IDE 以保持简单的方法和函数在一行上,而通常情况下,在代码重新格式化后,它们会扩展为多行。

  1. 在主菜单中,转到 设置 | 编辑器 | 代码样式 ,选择您的编程语言,然后打开 换行和大括号 标签。

  2. 重新设置格式时保持 部分,选择您想要忽略的格式规则,并取消选择您希望应用的规则。

  3. 重新格式化您的代码 (Ctrl+Alt+L).

IntelliJ IDEA 将根据当前的样式设置重新格式化您的代码,并保留您选择的规则的现有格式。

格式化程序设置

要访问设置,请在 设置 对话框(Ctrl+Alt+S )中,转到 编辑器 | 代码样式 ,并切换到 格式化程序 选项卡。

条目

描述

不设置格式

不设置格式 字段中,指定包含您想从 重新格式化代码排列导入优化中排除的文件和目录名称的 glob pattern ,例如: *.{html,htm}

您可以指定用分号 ; 分隔的几个通配符模式。

使用星号 * 通配符来完全禁用重新格式化。

在代码注释中使用标记打开/关闭格式化程序

  • 如果启用此选项,将根据这些标记重新格式化带有格式化标记的行注释之间的代码片段:带有开启标记的代码片段将被重新格式化,而带有关闭标记的片段在您重新格式化代码后将保持不变。 参见 使用格式化标记的示例

    在您勾选此复选框后,下方的字段将变为可用状态,您可以指定需要被视为格式标记的字符串。

  • 如果禁用此选项,将忽略格式标记,带标记的行注释之间的代码将被重新格式化。

关:

在此字段中,指定将表示您希望从重新格式化中排除的代码片段起始的字符字符串。 在前置词中键入带有 @ 符号的字符字符串,或保留预定义的值 @formatter:off

开:

在此字段中,指定将表示要从重新格式化中排除的代码片段结束的字符字符串。 在前置词中键入带有 @ 符号的字符字符串,或保留预定义的值 @formatter:on

在格式化程序标记中启用正则表达式

选择此复选框,使用正则表达式替代显式指定的格式标记。 IntelliJ IDEA 会使用指定的正则表达式来匹配格式化开/关标记,而不是精确的字符串。

例如,使用正则表达式可以让您有多个启用格式化器和禁用它的标记。 在这种情况下,您可以使用以下正则表达式: @formatter:(off|disable|no)@formatter:(on|enable|yes)

参见 使用格式化标记的示例 查看演示。

使用不同格式化标记的示例
最后修改日期: 2025年 9月 22日