开发哲学
- DRY –「Don't Repeat Yourself」不写重复的逻辑代码;
- 约定俗成 - 「Convention Over Configuration」,优先选择框架提倡的做法,不过度配置;
- KISS - 「Keep it Simple, Stupid」提倡简单易读的代码,不写高深、晦涩难懂的代码,不过度设计;
- 主厨精选 - 让有经验的人来为你选择方案,不独创方案;
- 官方提倡 - 优先选择官方推崇的方案。
设计理念
- MVC - Model, View, Controller ,以 MVC 为核心,严格控制 Controller 的可读性和代码行数;
- Restful - 利用『资源化概念』和标准的 HTTP 动词来组织你的程序;
代码规范
1,if不能嵌套超过三层,尽量取反return掉
2,循环不要嵌套超过三层,不要申明变量,查库等,除非必要的逻辑处理不要在循环中做
3,尽量减少重复代码,减少代码逻辑,如果逻辑过多,进行逻辑抽离,私有方法,静态方法等
4,命名必须遵从驼峰形式
5,一个函数的参数最多不要超过八个
6,一个函数行数不要超过200行,一个类最多不要超过2000行的代码
7,如果使用到了设计模式,建议在类名中体现出具体模式。
8,一行推荐的是最多写120个字符,多于这个字符就应该换行了,一般的编辑器是可以设置的(可以用phpcs-插件PSR-4规范)。
9,如 函数注释、变量注释等,常用标签有 @package、@var、@param、@return、@author、@todo、@throws
必须遵守 phpDocument 标签规则,修改代码的时候把对应的注释也修改一下
10,涉及到多个数据表 更新/添加 操作时,最外层要用事务,保证数据库操作的原子性;