PHP编程规范1_10.doc

PHP编程规范 前 言 为规范PHP开发的编码风格，提高开发效率和降低开发人员的时间成本，建立统一的PHP开发标准体系，依据国际、国内相关标准、法规，参照国际、国内通行的职业技能标准制定本规范。 适用范围 本规范规定了PHP开发当中的代码编写格式、注释及命名规则、错误及异常的处理方法、性能与安全的操作准则。确立了PHP开发工作的一般原则。针对PHP开发过程当中模糊不清的约定给出了统一明确的约定指南。 本标准适用于PHP开发团队。 说明 1.1 必须执行 必须执行的规范，用红字标明，违反相关规定每个扣0.5分，每次任务最多扣2分。 1.2 参考执行 参考执行的标准不强制执行只用于参考，但希望能开发人员编码风格能逐渐统一到该规范。 注释 一般规则 不写不必要的注释；只有当代码不能很好地说明逻辑时，才用注释补充； 把注释看成程序的一部分，在编写/维护代码时同时编写/维护注释； 注释完全采用PHPDocumentor的规范，以方便用其生成API级文档。 3.1 程序注释 注释示例代码： /*【组的M】(C)2001-2013Gamlaxy Inc. This is NOT a freeware, use is subject to license terms $RCSfile: forumdisplay.php,v $ $Revision: 1.7 $ $Date: 2006/02/23 13:44:02 $ */ 3.2 类、接口注释 在类、接口定义之前，应做相应注释，包括类、接口的目的、作用、功能、继承于何种父类，实现的接口、实现的算法、使用方法、示例程序等。 类、接口注释示例代码： 3.3 函数方法注释 　a）应明确该方法的功能、作用、各参数含义及返回值等。 　b）若在函数方法内注释复杂算法，应用/*...*/。 　c）为参数作注释时应注明取值范围和返回值，还应明确相应失败、错误、异常时的返回情况。 函数方法注释示例代码： 3.4 其它注释 程序开发中的临时代码和调试代码，应添加注释。譬如：“//debug”。 程序中不应该出现调试的print,echo,var_dump等语句。 3.5后期修改上的注释 在修改前人基础上的代码时，必须在修改的地方开始写上edted by xxxx 2011-2-10 start加上简单的程序修改说明，结尾地方写上 end 示例代码： 版权信息 注释名称 版权信息 注释示范 // // ++ // | phpDocumentor | // ++ // | Copyright (c) 2000-2003 Joshua Eichorn | // | Email jeichorn@ | // | Web | // ++ // | This source file is subject to PHP License | // ++ // 备注 使用//来标示版权信息，以免和PHPDocumentor的level DocBlock发生冲突 命名（下划线加不加待定）(A) 4.1 文件 文件名应使用小写英文字母和下划线：“_”，文件名不宜出现数字，不应使用纯数字命名。可用前缀来明确文件的类别及功能，例如：class_db_mysql.php。 4.2 变量 变量名中所有字母宜小写。对于一个变量使用多个单词的，应使用下划线’_’作为每个词的间隔。例如：$base_dir、$red_rose_price等。 4.2.1全局变量 全局变量使用$g_开头，如$g_data_list。 4.2.2 一般变量 一般的变量使用小写字母命名，单词之间使用下划线分隔。 变量名字应该使用名词或者形容词+名词的方式。如$value，$new_value。 4.2.3 临时变量 不要将在循环中频繁使用的临时变量如$i,$j等用于其它用途。 4.3 常量 常量应全部使用大写字母命名，少数特别必要的情况下，可以使用下划线来分隔单词；例如：define(A_GLOBAL_CONSTANT, Hello world!)；PHP的内建值TRUE、FALSE和NULL应全部采用大写字母书写。 类使用英文的大小写来分隔单词，包括首个单词，所有单词的首字母大写，如PageManager； 在类中，方法放到属性定义前边、公用方法放到专用方法前边； 一般情况下，一个类对应到一个文件； 当一些类关系紧密时，可以存放在一个文件中； 存放类的文件采用ClassName.class.php方式命名。 4.4 类、接口 类和接口命名，应以大写字母开头；多个单词组成命名，单词之间不必使用间隔，各个单词首字母宜使用大写。类和接口中属性的