PHP编码规范 v1.1.docVIP

PHP编码规范 版本 1.0 修订历史记录 日期 版本 说明 作者 2016-02-26 1.0 初稿 黄严静 2016-02-29 1.1 补充注释规范 PHP编码规范 1 1. 引言 1 2. 适用范围 1 3. 标准化的重要性和好处 1 4. PHP编码规范与原则 2 4.1. 代码标记 2 4.2. 注释 2 4.2.1文件头部注释 2 4.2.2函数头部注释 4 4.2.3类的注释 4 4.2.4程序代码注释 4 4.3. 书写规则 5 4.3.1. 缩进 5 4.3.2. 大括号{}、if和switch 5 4.3.3. 运算符、小括号、空格、关键词和函数 6 4.3.4. 函数定义 7 4.3.5. 引号 7 4.4. 命名原则 8 4.4.1. 变量、对象、函数名 8 4.4.2. 常量 9 4.5. 变量的初始化与逻辑检查 9 4.6. 安全性 9 4.7. 兼容性 10 4.8. 代码重用 10 4.9. 其他细节问题 10 4.9.1. 错误报告级别 10 引言 本规范由编程原则组成，融合并提炼了开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格。以达到事半功倍的效果，如果有需要本文档会不定期更新。 适用范围 Php项目开发。本规范规范，采用第三方开发框架（ii、ThinkPHP）以第三方框架规范为准则（） 不建议使用? ?和?=$variablename?这种速记形式。 注释 注释是对于那些容易忘记作用的代码添加简短的介绍性内容。请使用 C 样式的注释“/* */”和标准 C++ 注释“//”。 4.2.1文件头部注释 程序涉及业务名称 @version 版本 @date 最后更新时间 例如： /** * 商家控制器 （这是一个什么文件） * yvsm@ * @version 1.0 * @since 1.0 * @date 2015-12-07 */ 程序开发中难免留下一些临时代码和调试代码，此类代码必须添加注释，以免日后遗忘。所有临时性、调试性、试验性的代码，必须添加统一的注释标记“//debug”并后跟完整的注释信息，这样可以方便在程序发布和最终调试前批量检查程序中是否还存在有疑问的代码。例如： $num = 1; $flag = TRUE; //debug 这里不能确定是否需要对$flag进行赋值 if(empty($flag)) { //Statements } 4.2.2函数头部注释 /** * some_func * 函数的含义说明 * * @access public * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @param mixed $mixed 这是一个混合类型 * @author 缘境 yvsm@ * @since 1.0 * @date 2015-12-07 * @return array */ public function thisIsFunction($string, $integer, $mixed) {return array();} 4.2.3类的注释 /** * 类的介绍 * * 类的详细介绍（可选。）。 * @author 缘境 yvsm@ * @date 2015-12-07 * @version 1.0 * @since 1.0 */ class Test { } 4.2.4程序代码注释 /* 生成配置文件、数据文件。*/ $this-setConfig(); $this-createConfigFile(); //创建配置文件 $this-clearCache(); // 清除缓存文件 $this-createDataFiles(); // 生成数据文件 $this-prepareProxys(); $this-restart(); 书写规则 缩进 每个缩进的单位约定是一个TAB(8个空白字符宽度)，需每个参与项目的开发人员在编辑器(UltraEdit、EditPlus、Zend Studio等)中进行强制设定，以防在编写代码时遗忘而造成格式上的不规范。 本缩进规范适用于PHP、JavaScript中的函数、类、逻辑结构、循环等。 大括号{}、if和switch 首括号与关键词同行，尾括号与关键字同列； if结构中，else和elseif与前后两个大括号同行，左右各一个空格。另外，即便if后只有一行语句，仍然需要加入大括号，以保证结构清晰； switch结构中，通常当一个case块处理后，case块处理，if($condition) { switch($var) { ca