开发规约

一、代码的命名规范

类型	规则	正确示例	错误示例
Controller的命名	单数，大驼峰以Controller结尾	ArticleController	ArticlesController
Model的命名	单数，大驼以Model结尾	UserModel	Users
View的命名	蛇形命名	show_filtered.blade.php	showFiltered.blade.php, show-filtered.blade.php
Route的命名	复数	articles/1	article/1
Method、类中的方法名的命名	小驼峰命名	getAll	get_all
资源控制器的方法名命名	看具体的规定	store	saveArticle
变量的命名	小驼峰命名	$articlesWithAuthor	$articles_with_author
常量的命名	全大写、蛇形命名	MAX_STOCK_COUNT	Max_Stock_Count
Collection	具描述性的复数形式	$activeUsers = User::active()->get()	$active, $data
Object	具描述性的单数形式	$activeUser = User::active()->first()	$users, $obj
配置和索引文件	蛇形命名	articles_enabled	ArticlesEnabled; articles-enabled
Config配置文件的名称	蛇形命名	google_calendar.php	googleCalendar.php, google-calendar.php
Contract (interface)	形容词或名词	Authenticatable	AuthenticationInterface, IAuthentication
Table数据表的命名	表前缀+蛇形命名的复数形式	m_article_comments	article_comment, articleComments
外键的命名	带_id 后缀的单数型号名称	article_id	ArticleId, id_article, articles_id
主键	-	id	custom_id
数据表的字段类型设置	utf8mb4	-	-

注：
1、代码中的命名严禁使用拼音与英文混合的方式；

正例：alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。 
反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

2、杜绝完全不规范的缩写，避免望文不知义；

二、代码格式规范
1、大括号{}的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果 是非空代码块则：
1） 左大括号前不换行。
2） 左大括号后换行。
3） 右大括号前换行。
4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
2、小括号（） ，左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。

正例：if (a == b) 
反例：if ( a == b ) 

3、if/for/while/switch/do 等保留字与括号之间都必须加空格。
4、任何运算符的左右两边都需要加一个空格。
说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
5、采用 4 个空格缩进，禁止使用 tab 字符。
6、注释的双斜线与注释内容之间有且仅有一个空格。
正例：// 注释内容，注意在//和注释内容之间有一个空格。
7、单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进。
2） 运算符与下文一起换行。
3） 方法调用的点符号与下文一起换行。
4） 方法调用时，多个参数，需要换行时，在逗号后进行。
5） 在括号前不要换行。
8、方法参数在定义和传入时，多个参数逗号后边必须加空格。
正例：下例中实参的"a",后边必须要有一个空格。 method("a", "b", "c");
9、PHP所有关键字必须全部小写，常量 true 、false 和 null 也必须全部小写。
10、namespace 以及 use 声明
1）namespace 声明后必须插入一个空白行。
2）所有 use 必须 在 namespace 后声明。
3）每条 use 声明语句 必须 只有一个 use 关键词。
4）use 声明语句块后 必须 要有一个空白行。

三、控制语句
1、在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程 序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且 放在最后，即使它什么代码也没有。
2、 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用 单行的编码方式：

if (condition) statements; 

3、if()…else if()…else…方式表达逻辑，避免后续代码维 护困难，请勿超过 3 层，超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现。

四、注释规约
1、类、类属性、类方法的注释必须、使用/内容/格式，不得使用 // xxx 方式， 行注释如果用双斜线 //，则注意和注释内容之间必须有一个空格，方法内单行注释必须在被注释的语句上方另起一行，方法内多行注释必须与代码对齐；
2、所有的类都必须添加创建者和创建日期；
3、方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释 使用/ */注释，注意与代码对齐。

方法注释示例：
    /**
     *方法名称 请求方式:post
     * @desc  定时脚本每天0点执行一次
     * @param string name  生成文件的名称(文件名称的首字母大写,不需要添加后缀)  必填
     * @param arr fields  需要生成的字段  必填
     * @return str
     * @author Tom
     * @Time 2020/06/18 11:15
     * */

五、常量的定义
任何判断的位置，type，source，category等等，都用常量替换，需要字典的话定义常量字典：

六、其它
1、不要在视图模板中加入任何复杂的逻辑。
说明：根据 MVC 理论，视图的职责是展示，不要抢模型和控制器的活。
2、单个方法不要超过200行，代码过长可读性较差而且不容易维护；

参考 ：
Laravel 的十八个最佳实践
阿里开发规约