Linux下 PhpStorm 代码格式化实操指南
一 快速格式化
- 当前文件:在编辑器内按下快捷键 Ctrl + Alt + L(Linux),即可按当前项目的代码风格重排缩进、空格、换行等。
- 选区格式化:先选中一段代码,再按 Ctrl + Alt + L,仅对选区生效。
- 菜单触发:通过菜单 Code → Reformat Code 打开格式化对话框,可选择范围并执行。
- 快捷键冲突:若与系统快捷键冲突,可在 File → Settings → Keymap 中搜索 Reformat Code 重新绑定。
二 配置代码风格与缩进
- 选择规范模板:进入 File → Settings → Editor → Code Style → PHP,点击右上角 Set from… → Predefined style → PSR-12,快速应用主流规范。
- 自定义规则:在 Tabs and Indents 将 Tab size / Indent / Continuation indent 统一为 4;在 Wrapping and Braces 调整大括号与换行策略;在 Spaces 精确控制运算符、括号等空格策略。
- 文件类型差异化:为 Blade/Twig 等文件类型单独建立风格方案,避免与 PHP 规则互相影响。
- 团队共享:通过 Manage… → Export Scheme… 导出 XML 配置,团队成员导入即可保持一致。
- 缩进快速修正:编辑器右下角状态栏可一键 Convert Indents → To Spaces/To Tabs,并可用 Ctrl + Alt + L 重排当前文件缩进。
三 批量格式化与范围控制
- 多文件:在项目视图中 Ctrl 多选 多个 .php 文件,右键 Reformat Code,勾选 Run for selected files only,并可同时勾选 Optimize imports / Rearrange code。
- 整个目录:在项目视图中右键目标文件夹(如 app/ 或 src/)→ Reformat Code,按需勾选 Search in comments / Search in strings(默认关闭以避免改动注释与字符串),必要时启用 Process test sources。
- 按作用域:进入 File → Settings → Project → Scopes 新建作用域(如仅处理已修改文件:表达式可用 file:*.php && changed),格式化时在对话框 Show scopes 选择该作用域后执行。
四 保存时自动格式化与外部工具
- 保存即格式化:开启 Tools → Actions on Save,勾选 Reformat code,可同时按需勾选 Optimize imports,实现保存文件时自动排版。
- 使用 PHP-CS-Fixer:在项目根目录准备 .php-cs.dist 或 .php-cs-fixer.php 配置;在 File → Settings → Languages & Frameworks → PHP → Quality Tools → PHP-CS-Fixer 配置执行路径与配置文件;之后可通过右键或菜单使用 Reformat with PHP CS Fixer 按 PSR-2/PSR-12 等规则统一风格。
五 常见问题与小技巧
- 忽略某段代码:在不需要格式化的代码块前后添加注释 // @formatter:off 与 // @formatter:on。
- 检测缩进混用:在 Settings → Editor → Inspections → PHP → Code style issues → Mixed tabs and spaces 设为 Warning/Error,及时发现并修正。
- 显示/隐藏行号:在编辑器左侧空白处右键勾选 Show Line Numbers,便于审查与协作。