經歷了一段時間的磨合,總算是研究出一套最簡潔的命名方法,供大家叄考一下。
干過了幾個項目,首先了解到,簡潔清楚的命名方法是多麽重要的一回事。
這是從代碼簡潔之道這本書,還有看過國外幾個大牛的源碼,總結出來的東西。
1. 模組命名
MVPR是我最常用的架構,所以只集中說MVPR這種架構。
Model是業務層,我習慣用C語言的命名,比如CUser、CProduct、以C開頭。
V是視圖層,沒有特別的命名方法,按項目的業務來命名。
P是展視層,用UserPresenter,ProductPresenter來命名。
R是路由器、以UserRouter、ProductRouter來命名。
2. 變量
在公司工作,變量名要寫得十分簡明。
數量:AmountOfXXX、比如AmountOfLike、AmountOfProduct。
表單:動作_角色_實體,來命名。如EditUserProfileForm、UpdateProductImageForm。
表單變量:以實體_值,來命名。userNmae、userPassword、ProductPrice、AmountOfProduct。
遵從代碼簡約之道的原則,不要用Info、Temp,這些沒意義的名詞。
3. Presemder層
Presemder一般只有2個動作,渲染HTML,構造HTML代碼。
渲染HTML:以render_action_role_entity,來命名。如renderResigterUserForm、renderUpdateProductForm。
構造HTML代碼:以get_action_role_entity_HTML,來命名。如getUserTableHTML,getProductDescriptionHTML。
作為一個團隊,寧願要看得懂的長命名,也不要看不懂的短命名。
4. Model層
Model層,也是遵從代碼簡潔之道這本書。
數據庫的增刪改查,分別為create、delete、update、get。
action_entity_by_something。by后面的something,是指在什麽條件是處理action動作。
比如getUserByUserId。就是以UserId為條件,提取User資料。一目了然。
