1.【強制】所有文件名命名的時候使用全小寫,多個單詞之間使用下劃線分隔。
正例:admin_setting.class.php/admin_module.class.php/push_factory.class.php
2.【強制】 代碼中的命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結束。
反例: _name / __name / $Object / name_ / name$ / Object$
3.【強制】 代碼中的命名嚴禁使用拼音與英文混合的方式,更不允許直接使用中文的方式。說明:正確的英文拼寫和語法可以讓閱讀者易于理解,避免歧義。注意,即使純拼音命名方式也要避免采用。
反例: DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變量 = 3
正例: alibaba / taobao / youku / hangzhou 等國際通用的名稱,可視同英文。
4.【強制】類名使用英文全小寫,多個英文單詞之間使用下劃線分隔等。
正例:mixcall/ db_factory/ cache_memcache/ push_factory/ session_mysql
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
5.【推薦】方法名、參數名、成員變量、局部變量都統一使用 lowerCamelCase 風格,必須遵從駝峰形式。
正例: localValue / getHttpMessage() / inputUserId
6.【強制】常量命名全部大寫,單詞間用下劃線隔開,力求語義表達完整清楚,不要嫌名字長。
正例: MAX_STOCK_COUNT
反例: MAX_COUNT
7.【強制】抽象類命名使用 Abstract 或 Base 開頭;異常類命名使用 Exception 結尾;測試類命名以它要測試的類的名稱開始,以 Test 結尾。
8.【強制】杜絕完全不規范的縮寫,避免望文不知義。
反例: AbstractClass“縮寫”命名成 AbsClass;condition“縮寫”命名成 condi,此類隨意縮寫嚴重降低了代碼的可閱讀性。
9.【推薦】如果使用到了設計模式,建議在類名中體現出具體模式。
說明:將設計模式體現在名字中,有利于閱讀者快速理解架構設計思想。
正例:public class order_factory;
public class login_proxy;
public class resource_observer;
10.【參考】各層命名規約:
1) 獲取單個對象的方法用 get 做前綴。
2) 獲取多個對象的方法用 list 做前綴。
3) 獲取統計值的方法用 count 做前綴。
4) 插入的方法用 insert (推薦)或 save做前綴。
5) 刪除的方法用 delete(推薦)或 remove 做前綴。
6) 修改的方法用 update 做前綴。