重新格式化并重新排列代码

重新格式化代码片段

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

   重新格式化前，您可以查看应用于所选代码的代码样式设置：按 Alt+Enter 并单击 调整代码样式设置。

2. 在主菜单中，转到 代码｜ 重新设置代码格式 或按 Ctrl+Alt+L。

重新格式化文件

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

2. 在打开的 重新格式化文件 对话框中，如果需要，请选择以下重新格式化选项：

   

   • 优化import(O) ：选择此选项可移除未使用的 import、添加缺失的 import 或整理 import 语句。

     如需了解更多信息，请参阅 优化导入 部分。

   • 重新排序条目(R) ：选择此选项可根据代码样式设置中定义的 排列规则 重新排列代码。

   • 代码清理 ：选择此选项可运行代码清理检查。

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

3. 如果想查看重新格式化过程中对代码所做的具体更改，请使用 本地历史记录 功能。

重新格式化文件夹中的代码

1. 在项目视图中，右键单击文件夹，在上下文菜单中选择 重新设置代码格式 或按 Ctrl+Alt+L。

2. 在打开的对话框中，指定所需选项并单击 确定。

重新格式化行缩进

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

1. 在编辑器中，选择所需代码片段并按 Ctrl+Alt+I。

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

3. 在 制表符和缩进 选项卡中，指定适当的缩进选项并单击 确定。

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

当您的更改被 保存时，您可以将 IDE 配置为自动重新格式化已修改文件中的代码。

1. 按 Ctrl+Alt+S 打开设置，然后选择 工具｜保存时执行的操作。

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

3. 此外，您还可以配置 IDE 重新格式化代码的方式：

   • 单击 配置作用域… ，指定想要 从重新格式化中排除 的文件名和目录模式。

   • 从 所有文件类型 列表中，选择希望重新格式化代码的文件类型。

     

   • 如果项目处于版本控制之下，请选择 整个文件 或 更改的行。

     如果选择 更改的行 ，则仅重新格式化本地已更改但尚未提交到版本库的代码行。

提交时重新格式化代码

如果您的项目处于 版本控制之下，则在提交更改到版本库时可以自动重新格式化代码。 在这种情况下，只会重新格式化新增或修改的代码。

1. 按 Alt+0 打开 提交 工具窗口，然后单击 显示提交选项 。

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

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

从重新格式化中排除文件

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

1. 在 设置 对话框中（Ctrl+Alt+S ），转到 编辑器｜ 代码样式。

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

   您可以使用分号 ; 分隔多个 glob pattern。 如果单击 ，该字段会展开，每个 pattern 将显示在单独的一行上。

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

   

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

1. 在 设置 对话框（Ctrl+Alt+S ）中，转到 编辑器｜ 代码样式。

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

3. 在编辑器中，在要排除的区域开始处输入 @formatter:off。 在该区域的末尾，输入 @formatter :on。

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

此示例显示了两个代码片段。 其中一个 line 72 - line 76 被 @formatter :off 和 @formatter:on 标记包裹，而另一个 line 78 - line 81 则没有。

原始格式为：

标记内的代码（line 72 - line 76 ）保持其原有格式，而未使用标记的代码（line 78 - line 81 ）已重新格式化：

两个代码片段的原始格式均未保留：

保留现有格式

您可以选择在重新格式化代码时将忽略哪些格式规则。 例如，您可以将 IDE 设置为在一行中保留简单的方法与函数，而不是在重新格式化后将其展开为多行。

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

2. 在 重新设置格式时保持 部分，选择要忽略的格式规则，并取消选择应应用的规则。

3. 重新格式化代码 （Ctrl+Alt+L）。

WebStorm 将根据当前样式设置重新格式化您的代码，并保留您所选择规则的原始格式。