Php编程标准规范专业资料.docVIP

PHP 编程规范 （试行） 前 言 为规范 PHP 开发编码风格，提升开发效率和降低开发人员时间成本，建立统一 PHP 开 发标准体系，依据国际、中国相关标准、法规，参考国际、中国通行职业技能标准制订本规范。 本规范由大连市经济和信息化委员会提出并归口。 本规范项目召集单位： 本规范项目教授组： 本规范关键起草单位： 本规范起草人： 本规范于二○一○年十一月四日首次公布。 目录 TOC \o 1-3 \h \z \u 1. 适用范围 3 2. 定义和术语 3 2.1 PHP 语言 3 2.2 程序代码 3 3. 代码编写格式 3 3.1 代码标记 3 3.2 缩进 3 3.3 长度 4 3.4 行宽 4 3.5 间隔 4 3.6 对齐 4 3.7 括号 4 4. 注释 5 4.1 预注释 5 4.2 类、接口注释 6 4.3 函数方法注释 6 4.5 其它注释 7 5. 命名 7 5.1 文件 7 5.2 变量 8 5.3 常量 8 5.4 类、接口 8 5.5 方法、函数 8 6. 声明 8 6.1 类、接口 8 6.2 方法 8 6.3 变量 9 6.4 常量 9 6.5 其他 9 7. 表达式与语句 10 7.1 控制语句 10 7.2 循环语句 11 8. 错误与异常 11 8.1 已检查异常与运行时异常 11 8.2 异常错误提示设置 11 9. 测试与 BUG 跟踪 11 9.1 测试基本原则 11 9.2 BUG 跟踪和缺陷处理 11 10. 性能与安全 12 10.1 输入与输出 12 10.2 针对 PHP.INI 的规则 12 10.3 SQL 语句处理规则 12 11. 其它 12 12. 附录 12 12.1 注释模板 12 PHP 编程规范 1. 适用范围 本规范要求了 PHP 开发当中代码编写格式、注释及命名规则、错误及异常处理方法、 性能和安全操作准则。确立了 PHP 开发工作通常标准。针对 PHP 开发过程当中模糊不清 约定给出了统一明确约定指南。 本标准适适用于从事 PHP 开发相关企业、开发团体、教育和培训服务机构和相关决议等 机构，针对 PHP 开发工作进行约定、检验、判定和针对 PHP 开发人员技术培训。 2. 定义和术语 2.1 PHP 语言 PHP 是基于服务端应用和创建动态网页多用途脚本语言，可嵌入 HTML，并支持主流数 据库和操作系统。 2.2 程序代码 程序代码是一系列计算机系统能够识别，人类可读含有特定含义计算机语言字符集 合。 3. 代码编写格式 3.1 代码标识 PHP 程序能够使用?php ... ?或? ... ?来界定 PHP 代码，在 HTML 页面中嵌入纯变量时， 能够使用?=$variablename?这么形式。 3.2 缩进 PHP 程序中缩进宜按标准键盘 1 个“TAB”键，即 4 个空格为单位，一段程序中不应出 现两种缩进规则。 3.3 长度 a）单个函数有效代码长度应控制在 100 行以内，不包含注释行。 b）单个类有效代码长度应控制在 1500 行以内，不包含注释行。 3.4 行宽 每行 PHP 代码行宽宜设置为 80 个字符。 3.5 间隔 a）操作符两端应各空一个字符。 b）对应独立功效模块之间应使用注释行间隔，并标明对应内容。 c）程序体上下之间应加入一个空白行，不应使用多空行。 3.6 对齐 a）关系亲密代码行应对齐，比如类型、修饰、名称、参数等。 b）连续赋值时应对齐操作符。 c）方法参数过多时应在每个参数逗号后换行并对齐。 d）控制或循环中条件大于行宽时，应在操作符前换行，对齐并注释对应条件。 e）变量定义应经过添加空格对齐操作符，同一类型变量应放在一起。 3.7 括号 a）小括号（“( )”）使用过程中，“(”应和函数关键词紧贴在一起，除此以外宜使用空 格将“（”同前面内容分开；右括号“）”除后面是“）”或是“.”以外，其它内容应一律用 空格隔开； b）大括号（“{ }”）中语句应单独作为一行，其中： “{”应紧跟语句后； “}”应单独一行和程序体第一个字符对齐，并说明对应匹配功效模块； c）较长方法和类、接口等}后应使用//end ...等标识结束。比如： 类结束符：}//EOC ClassName， 方法结束符：}//end methodName()， 功效块结束：}//end if...userName is null? 循环体结束：}//end