統一的編碼規範能顯著提升團隊協作效率、降低維護成本。本文整理了一套適用於 PHP 專案的完整命名與風格規範,涵蓋變數、類別、方法、屬性、常數、縮排等核心面向。
_ 分隔。| 型態 | 前綴 | 範例 |
|---|---|---|
| 整數 | i | $i_age_max = 10; |
| 浮點數 | f | $f_price = 22.5; |
| 字串 | s | $s_name = 'harry'; |
| 布林值 | b | $b_flag = true; |
| 陣列 | a | $a_price = array(); |
| 物件 | o | $o_object = new ClassName(); |
| 資源 | r | $r_file = fopen(...); |
| 混合型態 | m | $m_var = array_combine($a_name, $a_flag); |
I 開頭,以 Interface 結尾。class UserProfile { }
class OrderService { }
interface ILoggerInterface { }
private 或 protected 方法以底線 _ 為前綴。get/set 前綴;設計模式相關方法(如 Singleton、Factory)名稱應包含模式名稱。class OrderService {
public function ProcessOrder() { }
protected function _ValidateInput() { }
private function _LogError() { }
public static function GetInstance() { } // Singleton
}
_。class User {
public $iAge;
private $_iAge;
public $sUserName;
}
參考類別屬性命名規則,例如:
public function SetUserName($sName) { }
g,其餘遵循變數命名規則。global $gi_Age; $ga_Price;define('E_ERROR_MISSING_PARA', 501);function get_user_list() { }建議採用「同行風格」(K&R 風格):
function foo() {
if (true) {
// code
}
}
if、while、for 等)與左括號間加一空格:if (condition)。func_name($arg)。return 語句除非必要,不加括號:return 1;。if (condition1) {
// ...
} elseif (condition2) {
// ...
} else {
// 建議保留 else 區塊,並加註釋說明用途
}
比較習慣:常數置於比較運算子左側(if (6 == $errorNum)),防止誤寫成賦值並利於閱讀。
default 分支,若理論上不可達,應拋出錯誤或記錄日誌。$result = ($condition)
? long_expression_true
: long_expression_false;
$iDate = 0;
$irDate = NULL;
$sName = '';
$mName = NULL;
不推薦:if ($result)
推薦:if ($result !== false) 或 if ($result > 0),明確表達業務邏輯。
///* ... *//** ... */,必須緊貼被描述的類別/方法/函數之前。/**
* 計算訂單總金額
* @param array $items 訂單項目
* @return float 總金額
*/
function calculate_total(array $items): float { }
建議開發完成後使用 IDE(如 PhpStorm、VS Code)進行代碼格式化,確保風格一致。