命名规范
- 参照PSR规范
- 英文: http://www.php-fig.org/
- 中文: https://github.com/PizzaLiu/PHP-FIG
- namespace、类名、类文件、与namespace映射的文件夹采用StudlyCaps大驼峰命名法;
- 方法名、属性名、变量名、视图文件中的php变量名采用camelCase小驼峰命名法;
- 函数名、非类文件、与namespace没有映射关系的文件夹采用下划线命名法;
- 全局常量、类常量采用大写下划线命名法;
- 数组键名采用下划线命名法;
- private方法下划线开头,protected和public方法需要字母开头;
- 与namespace映射的文件夹命名要与namespace一致;
- Controller放在Controllers文件夹下,Model放在Models文件夹下,Service放在Services文件夹下;
- Models层的文件名和类名都要加Model后缀,以此类推Services、Jobs、Providers等;
- 全局常量尽量少用,全局函数尽量少定义(尽量用类方法);
- 单个方法推荐代码不超过50行,超过需要考虑拆分细化为多个子方法[推荐];
IDE
- 统一使用一套IDE格式化模板;
- 推荐使用PhpStorm IDE,若右侧区域有提示黄色或者红色块,需要注意,可能代码存在隐藏bug[推荐]; TAB键用4个空格代替;
- 类、类方法、函数大括号换行,if等语句大括号同行;
- 每个文件必须以空行结束;
- 单行代码不宜过来,如超过屏幕显示区域则换行;