编码规范V1.020110801_moxiaoming.docVIP

系统开发规范 编 制： 莫 小 明 版 本 历 史 目录 1 概述 3 1.1. 内容 3 1.2. 编写目的 3 1.3. 阅读对象 3 2 php文件命名规范 3 3 php编码命名规范 4 2.1 Class 的命名 4 2.2 变量及方法命名 4 2.3 Static变量的命名 4 2.4 参数的命名 4 2.5 数组的定义及命名 5 2.6 方法的参数 5 2.7 内部循环变量的命名 5 4 php注释规范 5 3.1 单行注释 5 3.2 类注释 6 3.3 方法注释 6 3.4 变量注释 7 5 php编码排版规范 7 4.1 =间的空格 7 4.2 空行 8 4.3 换行 8 4.4 缩进 8 4.5 声明 8 4.6 括号 9 6 数据库编码命名规范 9 6.1 大小写说明 9 6.2 数据库表命名 9 6.3 视图命名 9 6.4 自定义函数命名 9 6.5 字段名命名 9 7 数据库SQL语句格式 10 7.1 大小写说明 10 7.2 insert into 语句 10 7.3 update 语句 10 7.4 select 语句 11 概述 内容 本规范说明书从大方面来说包括：PHP编码规范、数据库表、字段等的命名、SQL语句排版，以及后面补充的一些说明。 编写目的 编码规范对于程序员而言尤为重要，有以下几个原因：一个软件的生命周期中，80%的花费在于维护几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 php文件命名规范 文件命名一律全小写，出现多个字母用“_”连接，原因是有的不服务器只支持小写文件名，否则查找不到路径，振邦达的portal就是这样。 php编码命名Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。class AbstractMRPProductService { /*内容*/ } 保存为文件的文件名命名规则：xxxx_code.php。也提倡用xxxx.class.php之类来命名。 变量及方法命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头 EG 变量：$userName ,方法名： getUserInformation()、addNews() Static变量的命名 static变量的名字应该都大写，并且指出完整含义。 //每页显示记录数 public static $NAR_NUMBER = 10 ; 参数的命名 参数的名字必须和变量的命名规范一致。 数组的命名 array(1=’AA’,2=’BB’); 方法的参数 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： setCounter(int size) { $this-size = size; } 内部循环变量的命名 请不要用i、j、n等没有意义的变量命名； 不要怕麻烦，请使用带有意义的单词命名； 如：$userListSize、$rowLength等来命。 php注释规范注释要简单明了。//用户名userName = NULL; 类注释 /** * * 功能描述： * * @see * 与该类相关的类 * * @author (作者) * * @company (开发公司) /p * * @copyright (版权) 本文件归属/p * * @since (该版本支持的版本) ： * * @version (版本) * * @date (开发日期) * * @modify (修改) * p第一次修改：时间、修改人;修改内容简介 /p * p第二次修改：时间、修改人;修改内容简介 /p * p第三次修改：时间、修改人;修改内容简介 /p * @Review (审核人)： * *//** * 方法描述 * @param args array of string arguments * @return No return value * @exception exceptions No exceptions thrown */ public function myFunction($args) {