Laravel框架开发规范-修订版

Posted 2020-08-04 宗帅

1.php编码规范

　　1.1 标签

　　　　PHP 程序可以使用<?php ?>或<?= ?>来界定PHP代码

　　　　在html 页面中嵌入纯变量时，使用<?= ?>这样的形式

　　　　纯PHP类文件，文件开始标签使用<?php，闭合标签?>必须省略

　　1.2 编码

　　　　PHP文件必须使用无BOM的UTF-8编码方式

　　1.3 注释

　　　　单行注释：在语句后面使用“//”注释

　　　　多行注释：如下，注意换行

文件注释
/**
 * 描述
 *
 * @copyright Copyright© 2016, 公司名称
 * @author zongshuai
 * @Date: 16/7/15
 * @Time: 下午5:45
 */

方法或者函数注释
/**
 * 描述
 *
 * @param 类型 $fields 描述
 * @param 类型 $fields 描述
 * @return 类型 描述
 */

属性注释
/**
* 描述
*
* @var 类型
*/

　　1.4 命名规则

　　　　类：文件名和类名必须一致，切采用首字母大写的驼峰命名法

　　　　函数和方法：采用首字母小写的驼峰命名法，尽量用有意义，描述性的词语来命名，用checkForErrors()代替errorCheck()，用dumpDataToFile()代替dataFile()。

　　　　变量名：

　　　　　　　用有意义的，描述性的词语来命名变量

　　　　　　　别用缩写。用name, address, salary 等代替 nam, addr, sal 　 全局变量以”g_” 开头

　　　　　　　别使用单个字母的变量象i, n, x 等. 使用 index, temp 等

　　　　常量名：全部使用大写字母和下滑线组成,常量的名称中不允许出现小写字母，可使用分隔符作为下划线

　　1.5 书写规则

　　　　所有 PHP 文件必须以一个空行结束

　　　　行实际长度不应超过 80 个字符；较长的行应当被拆分成多个不超过80 个字符的后续行。

　　　　空行可以用来改善可读性和区分相关的代码块

　　　　一行不应多于一个语句

　　　　每个缩进的单位约定是4 个空格的缩进，并且不可使用制表符作为缩进，建议使用PhpStrom编辑器

　　　　每个运算符与两边参与运算的值或表达式中间要有一个空格

　　　　在绝大多数可以使用单引号的场合，禁止使用双引号（性能考虑）

　　　　PHP所有关键字必须全部小写。常量 true 、false 和 null 也 必须 全部小写

　　　　类的开始花括号（{） 必须 写在函数声明后自成一行，结束花括号（}）也 必须 写在函数主体后自成一行

　　　　方法的开始花括号（{） 必须 写在函数声明后自成一行，结束花括号（}）也 必须 写在函数主体后自成一行

　　　　方法名在声明之后不可跟随一个空格。左括号后面不可有空格，右括号前面不可有空格

　　　　关键词 extends 和 implements 必须 写在类名称的同一行。implements 的继承列表也 可以 分成多行，这样的话，每个继承接口名称都 必须 分开独立成行，包括第一个

　　　　类的属性和方法 必须 添加访问修饰符（private、protected 以及 public），abstract 以及final 必须 声明在访问修饰符之前

　　　　而 static 必须 声明在访问修饰符之后

　　　　如果存在abstract 和final 声明必须放在可见性声明前面

　　　　一定不可 使用关键字 var 声明一个属性。

　　　　每条语句 一定不可 定义超过一个属性

　　　　在参数列表中，逗号之前不可有空格，逗号之后必须要有一个空格

　　　　方法中有默认值的参数必须放在参数列表的最后面

　　　　参数列表可以被分为多个有一次缩进的多个后续行。如果这么做，列表的第一项必须放在下一行，并且每行必须只放一个参数。

　　　　当参数列表被分为多行，右括号和左花括号必须夹带一个空格放在一起自成一行。

2.数据库命名规范

　　2.1命名规范