Ubuntu下PhpStorm代码格式化操作指南
Ctrl+Alt+L(Ubuntu/Linux系统通用快捷键),即可快速格式化当前文件的代码,使其符合已设置的代码风格。Code→Reformat Code,会弹出对话框,默认选择“当前文件”,确认后即可格式化。若只需格式化部分代码,可先选中目标代码块(如函数、循环体等),再使用Ctrl+Alt+L快捷键或Code→Reformat Code菜单,仅对选中部分进行格式化。
若希望每次保存文件时自动应用格式化规则,可开启自动格式化功能:进入Settings(Ctrl+Alt+S)→Editor→General→Code Completion,勾选Code Format on Save选项,保存设置后即可在保存文件时自动格式化。
若默认规则不符合项目需求,可通过以下步骤自定义:
Settings(Ctrl+Alt+S)→Editor→Code Style→PHP。Tabs and Indents选项卡中,设置Tab size(制表符大小)、Indent(缩进大小,推荐4个空格)、Continuation indent(续行缩进);勾选Use tab character可切换为制表符,取消则使用空格。Spaces选项卡中,可设置运算符、逗号、冒号等符号前后的空格(如“=, =>前后加空格”)。Wrapping and Braces选项卡中,可配置代码换行规则(如“方法参数超过指定长度时换行”“数组元素换行”)、大括号位置(如“K&R风格”或“Allman风格”)。Scheme下拉菜单中,选择预定义的代码规范(如PSR-2,PHP社区广泛采用的标准),选择后所有设置会自动匹配该规范的默认值。Apply→OK,使自定义规则生效。若需要更严格的代码检查与格式化(如符合团队规范),可集成PHP_CodeSniffer或PHP-CS-Fixer工具:
composer global require "squizlabs/php_codesniffer=*",全局安装PHP_CodeSniffer。Settings→Languages & Frameworks→PHP→Quality Tools→Code Sniffer,点击Configuration File右侧的...,选择phpcs可执行文件路径(通常为~/.config/composer/vendor/bin/phpcs),点击Validate验证路径是否正确。Quality Tools→Code Sniffer Validation中,选择PSR2作为编码标准,点击Validate确认,随后勾选PHP Code Sniffer Validation以开启实时检查。composer global require friendsofphp/php-cs-fixer,全局安装PHP-CS-Fixer。Settings→Tools→External Tools,点击+添加新工具,填写以下信息:
Name:PHP-CS-Fixer(自定义名称);Program:php-cs-fixer(通过which php-cs-fixer命令获取路径,如~/.config/composer/vendor/bin/php-cs-fixer);Arguments:fix $FilePath$(格式化当前文件);Working directory:$ProjectFileDir$(项目根目录)。Code→Reformat with...→选择PHP-CS-Fixer,或使用Ctrl+Shift+Alt+F快捷键(需在Keymap中设置),调用工具格式化代码。Settings→Keymap,搜索Reformat Code或Code Style,修改冲突的快捷键。