萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 專案開發編碼規範完整指南

前言

統一的編碼規範能顯著提升團隊協作效率、降低維護成本。本文整理了一套適用於 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);

二、類別命名規範

  • 採用 PascalCase(大駝峰):每個單詞首字母大寫,其餘小寫,不使用底線。
  • 介面建議以 I 開頭,以 Interface 結尾。
class UserProfile { }
class OrderService { }
interface ILoggerInterface { }

三、方法命名規範

  • 採用 PascalCase,首字母大寫。
  • private 或 protected 方法以底線 _ 為前綴。
  • 存取器固定使用 get/set 前綴;設計模式相關方法(如 Singleton、Factory)名稱應包含模式名稱。
class OrderService {
    public function ProcessOrder() { }
    protected function _ValidateInput() { }
    private function _LogError() { }
    public static function GetInstance() { } // Singleton
}

四、類別屬性命名

  • 屬性名以型態前綴開頭(參考變數命名規則)。
  • 後續單詞採用 PascalCase。
  • 私有屬性加底線前綴 _。
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
    }
}

十、縮排與製表符

  • 使用 Tab 字元縮排(非空格)。
  • 每層級一個 Tab。

十一、括號、關鍵字與函數間距

  • 關鍵字(if、while、for 等)與左括號間加一空格:if (condition)。
  • 函數名與左括號緊貼:func_name($arg)。
  • return 語句除非必要,不加括號:return 1;。

十二、If-Then-Else 結構

if (condition1) {
    // ...
} elseif (condition2) {
    // ...
} else {
    // 建議保留 else 區塊,並加註釋說明用途
}

比較習慣:常數置於比較運算子左側(if (6 == $errorNum)),防止誤寫成賦值並利於閱讀。

十三、Switch 結構

  • 必須包含 default 分支,若理論上不可達,應拋出錯誤或記錄日誌。
  • 若需在 case 中宣告變數,請用大括號包裹。

十四、三元運算符

  • 條件式用括號包裹。
  • 複雜表達式換行書寫,保持清晰。
$result = ($condition)
    ? long_expression_true
    : long_expression_false;

十五、變數宣告對齊

$iDate      = 0;
$irDate     = NULL;
$sName      = '';
$mName      = NULL;

十六、避免隱式非零判斷

不推薦:if ($result)
推薦:if ($result !== false) 或 if ($result > 0),明確表達業務邏輯。

十七、註釋與文檔規範

  • 單行註釋://
  • 多行註釋:/* ... */
  • 文檔註釋(PHPDoc):/** ... */,必須緊貼被描述的類別/方法/函數之前。
/**
 * 計算訂單總金額
 * @param array $items 訂單項目
 * @return float 總金額
 */
function calculate_total(array $items): float { }

建議開發完成後使用 IDE(如 PhpStorm、VS Code)進行代碼格式化,確保風格一致。

copyright © 萬盛學電腦網 all rights reserved