整理了一份比较全面的php开发编码规范..pdfVIP

整理了一份比较全面的 PHP 开发编码规范 . 目录 1编写目的 2整体要求 3安全规范 3.1 包含文件 3.1.1 命名规则 3.1.2 存放规则 3.2 安全规则 3.3 一些针对 PHP 的规则 3.4 其它处理规则 3.4.1 对输入参数值进行转义处理 3.4.2 操作大 HTML 文本 4编码规范 4.1 命名规范 4.1.1 变量命名 4.1.2 类 4.1.3 方法或函数 4.1.4 缩写词 4.1.5 数据库表名 4.1.6 数据库字段 4.2 书写规则 4.2.1 代码缩进 4.2.2 大括号 { } 书写规则 4.2.3 小括号 ( ) 和函数、关键词等 4.2.4 ＝符号书写 4.2.5 if else swith for while 等书写 4.2.6 类的构造函数 4.2.7 语句断行 ,每行控制在 80 个字符以内 4.2.8 不要不可思议的数字 4.2.9 true/false 和 0/1 判断 4.2.10 避免嵌入式赋值 4.2.11 错误返回检测规则 4.3 程序注释 4.3.1 程序头注释块 4.3.2 类的注释 4.3.3 函数和方法的注释 4.3.4 变量或者语句注释 4.4 其他规范（建议） 4.4.1 php 代码标记 4.4.2 程序文件名、目录名 4.4.3 PHP 项目通常的文件目录结构 4.4.4 PHP 和 HTML 代码的分离问题 4.4.5 PHP 项目开发中的程序逻辑结构 5特定环境下 PHP 编码特殊规范 5.1 变量定义 5.2 引用的使用 5.3 变量的输入输出 1编写目的 为了更好的提高技术部的工作效率，保证开发的有效性和合理性，并可最大程度的提高程 序代码的可读性和可重复利用性，指定此规范。开发团队根据自己的实际情况，可以对本 规范进行补充或裁减。 2整体要求 技术部 php 开发规范将参照 PEAR 的规范，基本采用 PEAR 指定的规范，在其基础上增 加、修改或删除部分适合具体开发环境的规范。本规范只针对 PHP 开发过程中编码的规 范，对于 PHP 开发项目中文件、目录、数据库等方面的规范，将不重点涉及。 本规范包含了 PHP 开发时程序编码中命名规范、代码缩进规则、控制结构、函数调用、 函数定义、注释、包含代码、 PHP 标记、文件头的注释块、 CVS 标记、 URL 样例、常量 命名等方面的规则。 3安全规范 3.1 包含文件 3.1.1 命名规则 提取出来具有通用函数的包含文件，文件后缀以 .inc 来命名，表明这是一个包含文件。 如果有多个 .inc 文件需要包含多页面，请把所有 .inc 文件封装在一个文件里面，具体到页 面只需要包换一个 .inc文件就可以了 如:xxx_session.inc xxx_comm..inc xxx_setting.inc mysql_db.inc 把以上文件以一下方式，封装在 xxx.basic.inc 文件里面 require_once( ”xxx_session.inc ” ); require_once( ”xxx_comm.inc ” ); require_once( ”xxx_setting.inc ” ); require_once( ” mysql_db.inc ” ); 注：是否需要封装到一个文件，视情况而定，如果每个 inc 的功能是分散到不同的页面使 用的话，就不建议封装。 3.1.2 存放规则 一般包含文件不需要直接暴露给用户，所以应该放在 Web Server 访问不到的目录，避免 因为配置问题而泄露设置信息。 3.2 安全规则 请参考产品安全检查表。 输入和输出 检查是否做了 HTML 代码的过滤 可能出现的问题：如果有人输入恶意的 HTML 代码，会导致窃取