PHPStorm在Ubuntu上的代碼格式化技巧

PHPStorm在Ubuntu上的代碼格式化技巧

一、基礎格式化設置與操作

1. 打開設置窗口：啟動PhpStorm后，通過頂部菜單欄進入File > Settings（或使用快捷鍵Ctrl+Alt+S）。
2. 配置代碼風格規則：在設置窗口中導航至Editor > Code Style > PHP，可自定義以下核心規則：
   • 縮進與空格：將“Tab and Indents”中的“Use tab character”取消勾選（推薦用空格），設置“Tab size”“Indent”“Continuation indent”為4（或其他團隊統一值）；在“Spaces”選項卡中，勾選“Around operators”（運算符兩側加空格）、“After commas”（逗號后加空格）等選項，提升代碼可讀性。
   • 換行與對齊：在“Wrapping and Braces”選項卡中，勾選Align consecutive assignments（對齊連續賦值，如$name = 'John'; $age = 25;）、Align key-value pairs（對齊鍵值對，如數組或JSON格式），使代碼結構更整齊。
   • 快速選用規范：通過“Scheme”下拉菜單選擇預設規范（如PSR-2），一鍵應用行業通用格式標準，避免手動配置繁瑣。
3. 手動觸發格式化：
   • 當前文件：選中需格式化的代碼塊（或直接按默認快捷鍵Ctrl+Alt+L），即可自動調整代碼格式。
   • 整個項目：通過頂部菜單欄Code > Reformat Code，選擇“Reformat entire project”即可批量格式化項目代碼。

二、自動格式化增強技巧

1. 保存時自動格式化：進入Settings > Editor > General > Code Completion，勾選Format on Save（保存時自動格式化），避免忘記手動格式化的麻煩。
2. 導入語句自動優化：在Settings > Editor > General > Auto Import中，啟用Optimize imports on the fly（實時優化導入）和Add unambiguous imports on the fly（自動添加無歧義導入），可自動移除未使用的導入語句并按字母順序排列，保持導入部分的整潔。

三、外部工具集成（高級格式化）

若需更嚴格的代碼規范（如PSR-12），可集成PHP-CS-Fixer或PHP_CodeSniffer：

1. 安裝PHP-CS-Fixer：在終端運行composer global require friendsofphp/php-cs-fixer，安裝完成后通過which php-cs-fixer獲取其路徑（如/home/username/.composer/vendor/bin/php-cs-fixer）。
2. PhpStorm中配置PHP-CS-Fixer：
   • 進入Settings > Languages & Frameworks > PHP > Quality Tools > PHP CS Fixer；
   • 點擊“Configuration file”右側的...，選擇php-cs-fixer的可執行文件路徑；
   • 勾選PHP CS Fixer validation，選擇所需規范（如PSR-2），點擊Validate確認配置正確。
3. 使用外部工具格式化：
   • 通過菜單Code > Reformat with...，選擇已配置的PHP-CS-Fixer；
   • 或使用快捷鍵Ctrl+Shift+Alt+F（Linux）快速調用，適用于需要更嚴格格式化的場景。

四、實用進階技巧

1. 導入/導出代碼風格：在Code Style設置頁面，點擊“Scheme”下拉菜單旁的齒輪圖標，選擇Export可將當前樣式保存為.xml文件（便于團隊共享）；或選擇Import導入他人共享的樣式文件，快速統一項目風格。
2. 保留注釋與特殊字符：PhpStorm默認會盡量保留代碼中的注釋和特殊字符（如TODO、FIXME）的位置。若需更精細控制，可在Code Style > PHP的“Formatter”部分調整“Keep comments”（保留注釋）選項，避免格式化時注釋被移除。
3. 插件擴展功能：進入Settings > Plugins，搜索“PHP Formatter”相關插件（如“PHP Formatter by PHPStorm”），安裝后可增強格式化功能（如支持更多框架的代碼規范），提升格式化靈活性。