重新格式化代码
PhpStorm 可让您根据当前 代码样式方案或 .editorconfig 文件中指定的要求重新格式化代码。 如果在 .editorconfig 未定义任何内容,则将从项目设置中获取。
您可以重新格式化部分代码、整个文件、一组文件或一个目录。 您还可以从重新格式化中排除部分代码或某些文件。
格式化代码片段
在编辑器中选择您要重新格式化的代码片段。
在重新格式化之前,您可以查看应用于所选代码的代码样式设置:按 Alt+Enter 并点击 调整代码样式设置。
在主菜单中,前往 或按下 Ctrl+Alt+L。
或者,在显示的 工具栏上点击
重新格式化代码。
重新格式化文件
您可以在编辑器中打开文件并按 Ctrl+Alt+Shift+L ,或者在 项目 工具窗口中右键点击该文件并选择 。
在打开的 重新格式化文件 对话框中,您可以根据需要选择以下重新格式化选项:
优化导入 :如果您希望删除未使用的导入、添加缺失的导入或整理导入语句,请选择此选项。
有关更多信息,请参阅 优化导入 部分。
重新排列条目 :如果您需要根据代码样式设置中指定的 排列规则 重新排列代码,请选择此选项。
代码清理 :选择此选项以运行代码清理检查。
不保留换行符 :根据代码样式设置重新格式化换行符。 仅当 已在 中为当前语言启用时,此选项才可用。 如果选择 不保留换行符 ,IDE 会临时重写该设置,并根据当前代码样式移除现有换行。
也可以使用 再次重新格式化以移除自定义换行 选项,该选项位于 中。
重新格式化文件夹中的代码
在项目视图中,右键单击一个文件夹,然后从上下文菜单中选择 重新格式化代码 或按 Ctrl+Alt+L。
在打开的对话框中,指定必要的选项并单击 确定。
重新格式化行缩进
您可以根据指定的设置重新格式化行缩进。
在编辑器中,选择必要的代码片段并按 Ctrl+Alt+I。
如果您需要调整缩进设置,请在 设置 对话框(Ctrl+Alt+S )中,转到 。 选择您要更改缩进的语言。
在 制表符和缩进 选项卡上,指定适当的缩进选项,然后点击 确定。
保存时自动重新格式化代码
您可以将 IDE 配置为在更改被 保存时,自动重新格式化已修改文件中的代码。
按 Ctrl+Alt+S 打开设置,然后选择 。
启用 重新格式化代码 选项。
此外,您可以配置 IDE 重新格式化代码的方式:
点击 配置作用域… 以指定您要 排除在重新格式化之外的文件名和目录的模式。
从 所有文件类型 列表中选择您要重新格式化代码的文件类型。
如果您的项目在版本控制中,请选择 整文件 或 更改的行。
如果您选择 更改的行 ,代码重格式化将仅适用于本地更改但尚未提交到存储库的代码行。
在提交时重新格式化代码
如果您的项目在 版本控制下,您可以在提交更改到存储库时自动重新格式化代码。 在这种情况下,仅会重新格式化新增或修改的代码。
按 Alt+0 打开 提交 工具窗口,然后点击 显示提交选项
。
在 提交检查 菜单下,启用 重新格式化代码 选项。
启用该选项后,每次提交时,新增或修改的代码都会被重新格式化。

排除文件格式化
您可以从重新格式化、 代码排列和 导入优化中排除一组文件和目录。
在 设置 对话框(Ctrl+Alt+S ),转到 。
切换到 格式化器 选项卡,在 不设置格式 字段中,使用 glob 模式输入您想要排除的文件和目录。
您可以指定用分号
;分隔的几个通配符模式。 如果您点击,该字段将展开,每个模式将显示在单独的行上。
应用更改并关闭对话框。

在编辑器中排除代码片段的重格式化
在 设置 对话框(Ctrl+Alt+S ),转到 。
切换到 格式化器 标签并启用 使用代码注释中的标记打开/关闭格式化程序 选项。
在编辑器中,您希望排除的区域开头创建行注释 Ctrl+/ 并输入
@formatter:off。 在该区域的末尾,创建另一行注释并输入@formatter :on。标记之间的代码不会重新格式化。
示例显示了两个代码片段。 其中一个被包含在 @formatter:off 和 @formatter:on 标记中,而另一个没有。

原始格式得以保留:

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

保留现有格式设置
您可以选择在重新格式化代码时被忽略的格式化规则。 例如,您可以调整 IDE 以保持简单的方法和函数在一行上,而通常情况下,在代码重新格式化后,它们会扩展为多行。
在主菜单中,转到 ,选择您的编程语言,然后打开 换行和大括号 标签。
在 重新格式化时保留 部分中,选择希望 IDE 在重新格式化期间保留的现有格式设置类型。 对于希望 IDE 根据当前代码样式应用的格式设置,请清除相应的复选框。
重新格式化您的代码 (Ctrl+Alt+L).
PhpStorm 将根据当前的样式设置重新格式化您的代码,并保留您选择的规则的现有格式。