项目的命名规范

经历了一段时间的磨合,总算是研究出一套最简洁的命名方法,供大家叁考一下。

干过了几个项目,首先了解到,简洁清楚的命名方法是多麽重要的一回事。

这是从代码简洁之道这本书,还有看过国外几个大牛的源码,总结出来的东西。

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资料。一目了然。

原文地址:https://www.cnblogs.com/chenkuang/p/8136555.html