[计算机]php编码规范

《[计算机]php编码规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、编码规范编码规范11.引言12.适用范围23.标准化的重要性和好处24.PHP编码规范与原则24.1.代码标记24.2.注释24.3.书写规则34.3.1.缩进34.3.2.大括号{}、if和switch34.3.3.运算符、小括号、空格、关键词和函数44.3.4.函数定义54.3.5.引号64.4.命名原则64.4.1.变量、对象、函数名74.4.2.常量74.5.变量的初始化与逻辑检查74.6.安全性84.7.兼容性84.8.代码重用84.9.其他细节问题94.9.1.错误报告级别91.引言本规范由编程原则组

2、成，融合并提炼了开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格。以达到事半功倍的效果，如果有需要本文档会不定期更新。第9页共9页1.适用范围Php项目开发。2.标准化的重要性和好处当一个软件项目尝试着遵守公共一致的标准时，可以使参与项目的开发人员更容易了解项目中的代码、弄清程序的状况。使新的参与者可以很快的适应环境，防止部分参与者出于节省时间的需要，自创一套风格并养成终生的习惯，导致其它人在阅读时浪费过多的时间和精力。而且在一致的环境下，也可以减少编码出错的机会。缺陷是由于每个人的标准不同，所以

3、需要一段时间来适应和改变自己的编码风格，暂时性的降底了工作效率。从使项目长远健康的发展以及后期更高的团队工作效率来考虑暂时的工作效率降低是值得的，也是必须要经过的一个过程。标准不是项目成功的关键，但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。1.程序员可以了解任何代码，弄清程序的状况2.新人可以很快的适应环境3.防止新接触PHP的人出于节省时间的需要，自创一套风格并养成终生的习惯4.防止新接触PHP的人一次次的犯同样的错误5.在一致的环境下，人们可以减少犯错的机会6.程序员们有了一致的敌人3

4、.PHP编码规范与原则3.1.代码标记PHP程序可以使用或来界定PHP代码，在HTML页面中嵌入纯变量时，可以使用这样的形式。近年来PHP开发组一直倡导代码规范化和标准化，未来版本PHP可能会开始不建议使用甚至取消和这种速记形式，届时本文档也将进行跟进修改。3.2.注释注释是对于那些容易忘记作用的代码添加简短的介绍性内容。请使用C样式的注释“/**/”和标准C++注释“//”。在Discuz!每一个程序文件头部中

5、，应放入相应CVS控制字串，以方便CVS提交时自动更新：第9页共9页l$RCSfile$程序文件名l$Revision$修订版本号l$Date$最后更新时间例如：/*[DODI](C)2001-2006ComsenzInc.ThisisNOTafreeware,useissubjecttolicenseterms$RCSfile:forumdisplay.php,v$$Revision:1.7$$Date:2006/02/2313:44:02$*/程序开发中难免留下一些临时代码和调试代码，此类代码必须添加注释，以

6、免日后遗忘。所有临时性、调试性、试验性的代码，必须添加统一的注释标记“//debug”并后跟完整的注释信息，这样可以方便在程序发布和最终调试前批量检查程序中是否还存在有疑问的代码。例如：$num=1;$flag=TRUE;//debug这里不能确定是否需要对$flag进行赋值if(empty($flag)){//Statements}1.1.书写规则1.1.1.缩进每个缩进的单位约定是一个TAB(8个空白字符宽度)，需每个参与项目的开发人员在编辑器(UltraEdit、EditPlus、ZendStudio等)中

7、进行强制设定，以防在编写代码时遗忘而造成格式上的不规范。本缩进规范适用于PHP、JavaScript中的函数、类、逻辑结构、循环等。1.1.2.大括号{}、if和switch首括号与关键词同行，尾括号与关键字同列；if结构中，else和elseif与前后两个大括号同行，左右各一个空格。另外，即便if后只有一行语句，仍然需要加入大括号，以保证结构清晰；第9页共9页switch结构中，通常当一个case块处理后，将跳过之后的case块处理，因此大多数情况下需要添加break。break的位置视程序逻辑，与case同在

8、一行，或新起一行均可，但同一switch体中，break的位置格式应当保持一致。以下是符合上述规范的例子：if($condition){switch($var){case1:echo‘varis1’;break;case2:echo‘varis2’;break;default:echo‘varisneither1or2’;break;}}else{switch($str)