編碼規範(二)之命名規範
1.變數命名
PHP中的變數用一個美元符號後面跟著變數名錶示。變數名區分大小寫。一個有效的變數名由字母或者下劃線開頭,後面跟著任意數量的字母、數字或者下劃線。不應該在變數名中使用中文等飛ASCII字元。
1)程式整體
程式整體以駝峰法命名,以小寫字母開始,同時命名要有意義:
FunctiondisplayName($name){echo $name;}
2)PHP全域性變數鍵值
PHP全域性變數鍵值兩邊都有“_”,中間使用駝峰法命名,如:
$_GLOBAL[‘_beginTime_’];
3)普通變數
普通變數整體採用駝峰法,建議在變數前加表示型別的字首。不確定型別的以大寫字母開頭,函式引數不確定的型別以大寫字母開頭,其他地方的變數以小寫字母開頭,對於一些常見的變數,按照約定命名,並避免使用常見關鍵字或存在模糊意義的單詞,變數應該以名詞為主。
4)函式名
函式名既要有意義,一看就知道是什麼,也要儘量縮寫,建議使用動詞或者動詞加形容詞的命名方式。
5)類中的屬性
類中的屬性變數遵守普通變數的命名規則。
2. 類及介面命名
在面向風格的程式碼中,其命名方式有一些懸殊,類的命名遵循如下規則:
1) 以大寫字母開頭
2)多個單片語成的變數名,單詞之間不用間隔,各個單詞首字母大寫。
3)類名與類檔案保持一致。
4)抽象類應該以Abstract開頭。
類中的方法和函式採用同樣的命名規則:
介面命名規則遵循如下規則:
1)採用和類相同的命名規則,但其在命名前i字元,表示介面。
2)儘量保持和實現它的類命名一致。
3. 資料庫命名
在資料庫相關的命名中,一律不出現大寫。命名規則如下:
1)資料表的命名規範
表名均使用小寫字母
表名字使用統一的字首,且字首不能為空
對於多個單片語成的表名,使用“_” 間隔。
2)表字段命名遵循如下規則:
全部小寫字母命名
多個單詞不用下劃線進行分割
如果有必要,給常用欄位加上表名首字母作為字首
避免使用關鍵字和保留字,但約定俗成的除外
3)儲存過程、觸發器、event以及檢視的命名在表的命名規則的基礎上,遵循以下規則:
儲存過程以proc_開頭
觸發器以tri_開頭
Event排程以event_開頭
檢視以view_開頭
4. 習慣與約定
通常變數的命名應該是有意義的單詞,但在迴圈體中的臨時變數採用“IN規則”。
1) 縮寫
Image——img
String——str
Database——db
Array——arr
Count——cnt
Temporary——temp或tmp
Password——pwd或passwd
Message——msg
5. 魔術數字
數值需要變動時,只需要更改一個地方。
例如:
$price_tax=1.05*price;
應寫成:
Define(Tax,1.05);
$price_tax= TAX*price;