PHP命名規範

  • 駝峰式命名法(camelCase),小寫字母開頭,後面每個單字的第一個字母大寫。
  • 要使用描述性的命名方式。
  • 迴圈變數通常使用: $i, $j, $k, …等等。
  • 存放 session 的變數前面以 sess 開頭。
  • 存放 cookie 的變數前面以 coke 開頭。
  • 臨時性的變數前面以 tmp 開頭。
  • $query 和 $result 這兩個變數只能用在 SQL 的查詢語法變數與查詢結果變數。
  • 項目名稱(option)全部使用小寫及使用底線 _ (underscore)分隔。

常數命名

  • 常數名稱採用大寫英文字母。【PSR-1】
  • 必要時使用底線 _ (underscore)來區分單字。【PSR-1】
  • 如果內容有可能會改變,則採用變數而非常數。

類別命名

  • 必須使用大寫開頭的駝峰式命名(camelCase),又稱爲 TitleCase。【PSR-1】
  • extends 和 implements 關鍵字需和類別名稱在同一行。【PSR-2】

方法命名

  • 必須使用小寫開頭的駝峰式命名(camelCase)。【PSR-1】
  • 小寫字母開頭,後面每個單字的第一個字母大寫。【PSR-1】
  • 當參數的數量多長度超過最大值(80字)時,可以換行處理。換行後其他參數要縮排起始大括弧要在新的一行。【Zend 1】

SQL語法

  • 以 $query 變數名稱來存放 SQL 的命令。當發生錯誤時可以容易找出問題的地方。
  • 所有 SQL 的關鍵字必須採用大寫英文字母。
  • SQL 的寫法要分行,幫助程式碼容易閱讀與了解。

檔案命名

  • 檔案名稱完全採用小寫英文字母。
  • 字與字之間使用底線 _ 連接。
  • 一定要使用 .php 作為副檔名。
  • 會被引入的設定內容以 .inc.php 結尾。
  • 檔名長度必須小於 32 個字元(符合舊式系統)。