php编码规范

编码规范目录

1. 注释规范 2

2. 代码规范 3

3. 数据库规范 3

4. 接口规范 3

5. 文件规范 3

6. 性能规范 4

1. 注释规范

a.大段注释采用/**/的方式，通常为文件或函数的顶部，代码内部使用'//'；

b.注释不宜太多；代码注释应该描述为什么而不是做什么，给代码阅读者提供最主要的信息。

C.所属自己的文件只在开始部分注释、非所属修改请在行类注释自己的名字

所属

/**

* function_name //方法名

* @author kilvn //创建人

* @date 2016-10-10 //创建时间

* @version 1.0.0 //当前程序版本

* @param string or array //所需参数

* @paramdemo 2 or array('1', '2') //参数demo

*/

// test controller

非所属

// test controller by kilvn

2. 代码规范

a.类或方法的命名:类名(采用驼峰式除框架),方法名均使用小写，不使用下划线，尽量使用英文的组合；

b.类或方法开始和结束符号位置

c.变量均小写（没有规定的均使用小写）

Class one_class
{
function funtion_name()
{
//..
}
}

3. 数据库规范

a.数据库字段名称均使用小写,保证前台字段、sql查询、数据库字段名称和大小写一致；

B.tinyint 1个字段长度 （适用于状态） int(适用于时间戳特殊需求可以用datetime)

Varchar(适用于中文字段长度例如登录名) text（编辑器内容）

C.数据库字段注释(必须)

d.数据表(使用utf-8) 必须加表描述和责任人

例如:DEFAULT CHARSET=utf8 COMMENT='表描述 by kilvn';

4. 接口规范

a.接口传入参数和返回参数均使用小写（包括现有扩展接口）；

b.接口类和方法请遵守上面命名规则

5. 文件规范

a.脚本命名均使用小写加英文组合；

b.标准文档（如接口） 请保持 xxx20161010.doc 这样的格式

c.升级文件超过一个且未在同一目录，请从nginx制定目录向下整理目录层级和文件

d.替换或直接修改服务器文件需要备份原有文件，原文件命名 xxx.20161010.kilvn.xx（php）

6. 性能规范

a.使用$row[‘id’]方式取数据，不要使用$row[id]方式;

b.原因：$row[‘id’]的效率是$row[id]的7倍。

c.纯字符串使用单引号包含。原因：PHP会在双引号包围的字符串中搜寻变量，单引号则不会。

d.删除未使用的变量

e.原因：仅定义一个局部变量而没在函数中调用它，同样会减慢速度（其程度相当于递增一个局部变量）。PHP大概会检查看是否存在全局变量。

f.执行for循环之前确定最大循环数，不要每循环一次都计算最大值。

g.循环内部不要声明变量，尤其是大变量：对象(语言通用)。

h.执行字符串替换前用strpos()函数判断是否存在后再执行替换函数。

i.效率：如果需要替换：效率几乎相等，差别在 0.1% 左右;如果不需要替换：用 strops() 快 200%。

j.用foreach代替while遍历数组。遍历数组时foreach的效率明显高于while循环

k.str_replace函数比preg_replace函数快，但strtr函数的效率是str_replace函数的四倍

l.当执行变量$i的递增或递减时，$i++会比++$i慢一些。这种差异是PHP特有的

m.用@屏蔽错误消息的做法非常低效