今天写这个是为了 提醒自己 编程过程 不仅要有逻辑 思想 还有要规范 代码 这样可读性
感谢我牛神提供的文档
1、PHP 编程规范与编码习惯最主要的有以下几点：
1 文件说明
2 function 函数体说明
3 代码缩进
4 if省略
5 变量规范
6 命名规范
7 十行一注释
8 注释风格
9 开放关闭原则
2、文件说明 个人代码 -规范如下:
1 <? 2 /* 3 +---------------------------------------------------------------------- 4 + Title : 标题 5 + Author : 作者 6 + Version : 版本号 7 + Initial-Time : 这个文件初始创建的时间 8 + Last-time : 这个文件最后修改的时间 + 修改人的名称 9 + Desc : 这个文件的简单描述 10 +---------------------------------------------------------------------- 11 */
3、Function 函数体说明：
1 <? 2 /** 3 * 函数体简单的描述 4 * @author_start : 作者 5 * @author_end : 修改时间 + 修改者 6 * @param string : $id 描述 7 * @param array : $array 描述 8 * @param array : $num 描述 9 * @return : 返回值说明 10 */ 11 function Test($id, $array = array(), $num = 1){ 12 }
注意:Function里面变量参数的代码缩进风格
4、代码缩进：
1 <? 2 $str = 1; 3 $info = '123'; 4 $version = '123123'; 5 $name = 'test'; 6 $i = 'haha'; 7 8 # 一般在最外部的if 或流程控制语句都应该上下留空一行 9 if ($info) { 10 11 } 12 13 # 一般在最外部的for或者 foreach都应该上下留空一行 14 for ($i=0 ,$i<6 ,$i++){ 15 16 }
5、IF省略
1 <? 2 # 一般在if语句与其分支的流程控制语句当中,存在这exit或者return的情况下,都应该省略其else的部分操作 3 # 错误 4 if () { 5 return false; 6 } else { 7 return true; 8 } 9 # 正确 10 if () { 11 return false; 12 } 13 return true;
6、变量规范，使用英文命名
1 <? 2 # 正确 3 $title = '标题'; 4 $name = '名称'; 5 $pwd = '密码'; 6 # 错误 7 $biaoti = '标题'; 8 $ming = '名称'; 9 $mima = '密码';
7、命名规范
1 <? 2 /** 3 * 实际开发中，命名方式一般有三种情况 4 * 注意：不管是类名，变量，方法名，在实际开发中，最多只能是不超过3个单词的组合 5 * 大驼峰 ：每个单词首字母大写 6 * 小驼峰 ：中间单词首字母大写 7 * 蛇形 ：每个单词小写，单词与单词之间使用 _ 符合链接 8 */ 9 10 # 大驼峰，常用于类名定义 11 class Car{} 12 class BlueCar{} 13 14 # 小驼峰，常用于方法名定义 15 class Car{ 16 public function getColor(){} 17 } 18 19 # 蛇形，常用于变量名定义 20 $res_id = 1; 21 $res_name = 2;
9、注释风格
1 <? 2 1、当需要对某段代码，做大量描述时，使用以下注释风格 3 /** 4 * 我是说明 5 * ① 流程一 6 * ② 流程二 7 * ③ 流程三 8 */ 9 10 2、当需要对一行代码，做小量描述时，使用以下注释风格 11 # 这是XXXX给ZZZZ的变量，叫CCCC 12 $name = ''; 13 14 3、当需要对一行代码，做简介描述时，使用以下注释风格 15 $name = ''; // X表的字段 16 $index_head = ''; // 首页请求头
10、开放关闭原则
实际上这是一个概念，是设计模式中的一种。
简单来说，就是一个已经完成上线的class或者api，可以在不改动起原文件的情况下，对其功能进行外部扩展。