PHP
|
PHP程序员编程规范 |
数据库设计规范:
-
所有数据表必须有注释;
-
所有字段必须有注释;
-
数据库统一使用phpMyAdmin来操作,数据字典可以不做。
-
复杂系统(超过10张表),必须在注释里表明主表,格式: 【主表】; 一般主表为用户表,员工表,客户表组成;
-
每张数据表的自动增长字段(AI),必须用小写的“id", 此为唯一主键;
-
严格上讲,不要用"name", "title" 这样的常见名作为字段名。可以加一个小写字母然后字段名大写命名,例如:cName, cTitle ,
sTime等。这样做到好处是可以避免字段有意义,程序莫名出错;
-
每个表单与数据库字段名必须对应,由于采用无意义命名规则,在表单JS处理方面也避免意外BUG;
-
数据库设计,在超过5万条记录的时候,必须建立索引,索引规则利用explain+ sql 进行。具体的会有另外的教程讲解。
-
用整数表示特殊意义的字段,按这样的格式写注释: 类型: 1|刚发布,2|已审核,3|驳回 其中:前面的为说明,后面的为具体数值; |
前面的为数字,后面的含义;
代码书写规范:
-
必须使用缩进,缩进必须使用"tab",不能用空格;
-
每个函数的结尾必须使用 "//end functionname" 来结尾;
-
每个函数的输入、返回,必须做注释;3个字段参数以内的可以一行写完;参数多的可以分多行;
-
一个函数超过100行代码的,要考虑分函数;
-
一个函数集文件超过1000行代码的,要考虑用类封装,利用PHP 的
静态类成员方法,封装成静态类函数,调用形式如:Common::check_empty
-
凡是要用到2次的地方,都要考虑封装成函数;
-
尽量使用 c_pro, v_list, v_form ,c_del
来命名页面函数,一个数据表的增删改查可以放同一个页面,这样的命名有利于大型系统的MVC分离;
-
没有把握的函数或语句,必须写测试文件测试,每一段代码尽量做到高内聚,低耦合,提高健壮性;
|
|