Php编程标准规范专业资料.doc
《Php编程标准规范专业资料.doc》由会员分享,可在线阅读,更多相关《Php编程标准规范专业资料.doc(20页珍藏版)》请在咨信网上搜索。
1、PHP 编程规范(试行)前言为规范 PHP 开发编码风格,提高开发效率和减少开发人员时间成本,建立统一 PHP 开 发原则体系,根据国际、国内有关原则、法规,参照国际、国内通行职业技能原则制定本规范。本规范由大连市经济和信息化委员会提出并归口。 本规范项目召集单位: 本规范项目专家组:本规范重要起草单位:本规范起草人: 本规范于二一年十一月四日初次发布。目录1.适用范围32.定义和术语32.1 PHP 语言32.2 程序代码33.代码编写格式33.1 代码标记33.2 缩进33.3 长度43.4 行宽43.5 间隔43.6 对齐43.7 括号44.注释54.1 预注释54.2 类、接口注释64
2、.3 函数方法注释64.5 其它注释75.命名75.1 文件75.2 变量85.3 常量85.4 类、接口85.5 方法、函数86.声明86.1 类、接口86.2 方法86.3 变量96.4 常量96.5 其他97.表达式与语句107.1 控制语句107.2 循环语句118.错误与异常118.1 已检查异常与运行时异常118.2 异常错误提示设置119.测试与 BUG 跟踪119.1 测试基本原则119.2 BUG 跟踪和缺陷处理1110.性能与安全1210.1 输入与输出1210.2 针对 PHP.INI 的规则1210.3 SQL 语句处理规则1211.其它1212. 附录1212.1 注
3、释模板12PHP 编程规范1.合用范畴本规范规定了 PHP 开发当中代码编写格式、注释及命名规则、错误及异常解决办法、性能与安全操作准则。确立了 PHP 开发工作普通原则。针对 PHP 开发过程当中模糊不清 商定给出了统一明确商定指南。本原则合用于从事 PHP 开发有关公司、开发团队、教诲和培训服务机构以及有关决策等 机构,针对 PHP 开发工作进行商定、检查、鉴定以及针对 PHP 开发人员技术培训。2.定义和术语2.1 PHP 语言PHP 是基于服务端应用和创立动态网页多用途脚本语言,可嵌入 HTML,并支持主流数 据库和操作系统。2.2 程序代码程序代码是一系列计算机系统可以辨认,人类可读
4、具备特定含义计算机语言字符集 合。3.代码编写格式3.1 代码标记PHP 程序可以使用或来界定 PHP 代码,在 HTML 页面中嵌入纯变量时, 可以使用这样形式。3.2 缩进PHP 程序中缩进宜按原则键盘 1 个“TAB”键,即 4 个空格为单位,一段程序中不应出 现两种缩进规则。3.3 长度a)单个函数有效代码长度应控制在 100 行以内,不涉及注释行。b)单个类有效代码长度应控制在 1500 行以内,不涉及注释行。3.4 行宽每行 PHP 代码行宽宜设立为 80 个字符。3.5 间隔a)操作符两端应各空一种字符。 b)相应独立功能模块之间应使用注释行间隔,并标明相应内容。 c)程序体上下
5、之间应加入一种空白行,不应使用多空行。3.6 对齐a)关系密切代码行应对齐,例如类型、修饰、名称、参数等。b)持续赋值时应对齐操作符。 c)办法参数过多时应在每个参数逗号后换行并对齐。 d)控制或循环中条件不不大于行宽时,应在操作符前换行,对齐并注释相应条件。 e)变量定义应通过添加空格对齐操作符,同一类型变量应放在一起。3.7 括号a)小括号(“( )”)使用过程中,“(”应和函数核心词紧贴在一起,除此以外宜使用空 格将“(”同前面内容分开;右括号“)”除背面是“)”或者是“.”以外,其他内容应一律用 空格隔开;b)大括号(“ ”)中语句应单独作为一行,其中: “”应紧跟语句后; “”应单独
6、一行与程序体第一种字符对齐,并阐明相应匹配功能模块;c)较长办法以及类、接口等后应使用/end .等标记结束。例如: 类结束符:/EOC ClassName,办法结束符:/end methodName(), 功能块结束:/end if.userName is null?循环体结束:/end for.every user in userList 示例:?Php /代码标记 3.1/缩进 3.2- for($i = 0;$i 0)$n = $i;/变量对齐 3.6-$count= 100;$length= 0;$user_name = null;$porduct= array();/声明数组/参数
7、对齐 3.6- getConnection($url,$user_name,$password). /getConnection()结束/换行对齐 3.6-$sql = SELECT * . FROM TProduct WHERE Prod_ID = .$prod_id;/条件对齐- if( Condition1/当条件一& Condition2/并且条件二| Condition3) /或者条件三./操作符两边空格-$result = ($a + 1) * 3 / 2 + $num).Test;$condition ?func1($var) :func2($var);?4.注释4.1 预注释预
8、注释中,应涉及程序名称、程序版本及修订版本号、CVS(版本控制系统)控制字符串、更新时间等信息内容。在预注释中,宜放入相应 CVS 控制字串,以以便 CVS 提交时自动更 新。宜采用多行注释方式。预注释示例代码:/*开发组名称和版权声明等$RCSfile:forumdisplay.php,v $Revision:1.75$Date:/02/23 13:44:02$*/4.2 类、接口注释在类、接口定义之前,应做相应注释,涉及类、接口目、作用、功能、继承于何种父 类,实现接口、实现算法、用法、示例程序等。类、接口注释示例代码:/* 字符串实用类* 定义字符串操作时所需要用到办法,如转换中文、HT
9、ML 标记解决等。* author $Author:l_walker$* version $Revision:1.2 $ $Date:/05/15 02:10:27 $*/public class StringUtil4.3 函数办法注释a)应明确该办法功能、作用、各参数含义及返回值等。 b)若在函数办法内注释复杂算法,应用/*.*/。 c)为参数作注释时应注明取值范畴和返回值,还应明确相应失败、错误、异常时返回状况。 函数办法注释示例代码:/* 执行查询。* 该办法调用 Statement executeQuery(sql)办法并返回 ResultSet* 成果集。* param sql 原
10、则 SQL 语句* return ResultSet 成果集,若查询失败则返回 null* throws SQLException 当查询数据库时也许引起此异常*/function execute_query($sql) /SQL 语句都不能为空if( != $sql)/返回查询执行成果return mysql_query($sql);return null;/end eexecute_query()4.5 其他注释程序开发中暂时代码和调试代码,应添加注释。譬如:“/debug”。 其他注释示例代码:$num= 1;$flag = TURE;/debug if(empty($flag). /S
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- Php 编程 标准规范 专业 资料
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【a199****6536】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【a199****6536】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。