Ubuntu PHPStorm如何進行代碼格式化

Ubuntu下PhpStorm代碼格式化操作指南

一、基礎格式化操作

1. 手動格式化當前文件

• 快捷鍵方式：在打開的PHP文件中，按下Ctrl+Alt+L（Ubuntu/Linux系統通用快捷鍵），即可快速格式化當前文件的代碼，使其符合已設置的代碼風格。
• 菜單方式：點擊頂部菜單欄的Code→Reformat Code，會彈出對話框，默認選擇“當前文件”，確認后即可格式化。

2. 格式化選中代碼塊

若只需格式化部分代碼，可先選中目標代碼塊（如函數、循環體等），再使用Ctrl+Alt+L快捷鍵或Code→Reformat Code菜單，僅對選中部分進行格式化。

3. 保存時自動格式化

若希望每次保存文件時自動應用格式化規則，可開啟自動格式化功能：進入Settings（Ctrl+Alt+S）→Editor→General→Code Completion，勾選Code Format on Save選項，保存設置后即可在保存文件時自動格式化。

二、自定義代碼格式化規則

若默認規則不符合項目需求，可通過以下步驟自定義：

1. 打開Settings（Ctrl+Alt+S）→Editor→Code Style→PHP。
2. 調整縮進與空格：
   • 在Tabs and Indents選項卡中，設置Tab size（制表符大?。?、Indent（縮進大小，推薦4個空格）、Continuation indent（續行縮進）；勾選Use tab character可切換為制表符，取消則使用空格。
   • 在Spaces選項卡中，可設置運算符、逗號、冒號等符號前后的空格（如“=, =>前后加空格”）。
3. 設置換行與包裹：
   在Wrapping and Braces選項卡中，可配置代碼換行規則（如“方法參數超過指定長度時換行”“數組元素換行”）、大括號位置（如“K&R風格”或“Allman風格”）。
4. 選擇代碼規范：
   在Scheme下拉菜單中，選擇預定義的代碼規范（如PSR-2，PHP社區廣泛采用的標準），選擇后所有設置會自動匹配該規范的默認值。
5. 保存設置：點擊Apply→OK，使自定義規則生效。

三、使用外部工具增強格式化（可選）

若需要更嚴格的代碼檢查與格式化（如符合團隊規范），可集成PHP_CodeSniffer或PHP-CS-Fixer工具：

1. 配置PHP_CodeSniffer

• 安裝工具：在終端運行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以開啟實時檢查。

2. 配置PHP-CS-Fixer

• 安裝工具：在終端運行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，修改沖突的快捷鍵。
• 自定義規則時，建議參考項目團隊的編碼規范（如PSR-1/PSR-2/PSR-12），確保代碼風格統一。
• 使用外部工具時，需確保工具版本與PhpStorm兼容，并定期更新以避免兼容性問題。