PHP项目规范编码.ppt

PHP编码规范 2015.4.3 1.?缩进方式 以层次方式缩进，使用Tab键Tab(4个字符)的缩进，不可使用空格缩进，Tab设置时不要使用空格填充。 2.?语义分隔 各个类、函数、方法之间应该采用空行间隔； 同一个函数中联系紧密的语句之间可以不换行，其他情况需要换行；代码中处理同一内容的语句与其它语句间使用空行。 3.?空格规则 3.1.?逻辑运算符前后必须加空格 正确?$a?==?$b; 错误?$a==$b; 正确?$a++;?$a--; 错误?$a?++;?$a?--; 备注?加一减一运算符不能加空格。 PHP编码规范 3.2.?多个参数分隔时必须加空格 正确?$gPro,?$gUser,?gShow; getDbInfo($host,?$user,?$passwd); 错误?$g_pro,$g_user,$g_show; get_dbInfo($host,$user,$passwd); 3.3.?语法关键字后必须加空格 例如：if,?for,?while,?switch?….. ? 正确?for?($i?=?0;?$i??10;?$i++) 错误?for($i?=?0;?$i??10;?$i++?) PHP编码规范 4.?字符串和变量连接规则 字符串与变量连接使用‘.’号时，必须在‘.’前后加空格，使用“号时，必须在变量前后“{}” ? 正确?$myName?=?’file_’?.?$var1; $myName?=?”file_{$var1}”; 错误?$myName?=?’file_’.$var1; $myName?=?”file_$var1″; 5.?圆括号规则 函数名后括号不需要加空格、语法关键字后的括号必须加空格。 正确?for?($i?=?0;?$i??10;?$i++) strlen($myName); 错误?for($i?=?0;?$i??10;?$i++?) strlen?($myName); PHP编码规范 6.?花括号规则 花括号必须为上下对应。 if?($a)?{ $b?=?$a; } if?($a) { $b?=?$a; } 7.?数组定义规则 数组定义和使用时中key值前后必须加单引号。7倍 PHP编码规范 PHP中SQL语句编写规范 数据库中，库名、表名、字段名禁止使用SQL关键子，所有库名、表名、字段名均使用小写字母表示，名字中不能有空格； 在PHP中嵌入的SQL语句关键字全部采用大写； 数据值两边用单引号‘’包括，SQL语句遵循标准SQL格式，并且应确保数据值中的单引号已经转义以防止SQL注入。 正确?$sql?=?”SELECT?username?FROM?user?WHERE?id?=?’$id’”; 错误?$sql?=?”select?username?from?name?where?id?=?$id?”; PHP编码规范 - SQL语句编写规范 PHP编码规范 - 注释规范 不写不必要的注释； 只有当代码不能很好地说明逻辑时，才用注释补充； 1.?注释格式 把注释看成程序的一部分，在编写/维护代码时同时编写/维护注释； 如： /** *?运算控制类ExampleClass * *?实现数据运算的扩展 *? *?@author: zhangsan zhangsan@dodoca.net *?@date?2014-8-13 */ Class?ExampleClass { /** *成员变量注释 */ public?$var; private?$private; /** *?函数add,实现两个数的加法 ? ??* ? ??*?一个简单的加法计算，函数接受两个数a、b，返回他们的和c ? ??*? ? ??*?@param?int?加数 ? ??*?@param?int?被加数 ? ??*?@return?integer? ? ? */ ? ? public?function?add($a,?$b) ? ? { return?$a+$b; } } 注释规范 2.?注释位置 2.1.?文件头部 在每个文件头部加上该文件功能的简单介绍，作者，时间等，如果该文件是类文件时，则写类注释。 2.2.?类定义时 a.?定义类时应该加上注释，描述该类大概实现的功能，作者，时间等； b.?类中的public与protected变量如不能明确表达意思时应该加上注释； c.?类中的public与protected方法应该加上详细注释（功能，参数，返回值等）； d.?使用interface开发时，interface方法加详细注释（功能，参数，返回值等），具体实现可以不写。 e.?类中的