1. 【強制】代碼中的命名均不能以下劃線開始,也不能以下劃線或美元符號結束;
反例:_name , __namename_ , name$ , Object$
2. 【強制】代碼中的命名嚴禁使用拼音與英文混合的方式,更不允許直接使用中文的方式;
說明:正確的英文拼寫和語法可以讓閱讀者易于理解,避免歧義。注意,即使純拼音命名方式也要避免采用
正例:benben henan zhengzhou 等國際通用的名稱,可視同英文
反例:getXiaoxi()[獲取消息] , getPingfen() [獲取評分]
3. 【強制】類名使用 HookAddonsCase 風格,必須遵從大駝峰形式;
正例:Goods,OrderGoods,HookAddons
反例:macroPolo,XMLService
4. 【強制】方法名統一使用 getUserName 風格,必須遵從小駝峰形式;
正例: getUserName,getUserAddress
5. 【強制】函數名統一使用 get_user_name 風格,必須使用小寫字母, 不能使用數字,每個單詞用下劃線分割;
正例:get_user_name ,get_user_address
反例:get_user_name1,GET_user_Name
6. 【強制】命名空間統一使用 app\admin\model 風格,必須使用小寫字母, 不能使用數字,下劃線,大寫字母;
正例:app\admin\model,app\admin\controller
反例:app\admin\Controller
7. 【強制】杜絕完全不規范的縮寫,避免望文不知義;
反例:AbstractClass“縮寫”命名成 AbsClass;condition“縮寫”命名成 condi,此類隨意縮寫嚴重降低了代碼的可閱讀性
8. 【推薦】為了達到代碼自解釋的目標,任何自定義編程元素在命名時,使用盡量完整的單詞組合來表達其意;
正例:獲取用戶名稱的名稱為 get_user_name 或get_username。
反例:變量 $a = 1; 的隨意命名方式。
9. 【強制】文件命名
1)模塊名只允許小寫字母,
2)TP控制器,模型,驗證器文件名同類名一致
3)模板文件一律使用小寫,駝峰法命名的控制器方法對應的模板請直接使用下劃線分隔開,嚴禁出現大小寫混用的模板文件名,避免在Linux服務器下因為大小寫而報模板找不到的錯誤
正例:goods_add.html
反例:goodsAdd.html
10. 【強制】常量命名全部大寫,單詞間用下劃線隔開,力求語義表達完整清楚,不要嫌名字長;
正例:UID,ROOT_DIR
11. 【參考】各控制器,模型方法命名規約:
1) 獲取單個對象的方法用 get 做前綴;
2) 獲取多個對象的方法用 list 做前綴;
3) 獲取統計值的方法用 count 做前綴;
4) 插入的方法用 save/insert 做前綴;
5) 刪除的方法用 remove/delete 做前綴;
6) 修改的方法用 update 做前綴;