DoitPHP编码规范.docVIP

DoitPHP编码规范 引言 本规范基于PHP PEAR编码规范及PHPDocumentor注释规范等编程原则组成，融合并提炼了开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格。以达事半功倍的效果。为了与时俱进，根据客观需求，本文档会不定期更新。 作者：tommy streen003@ 版权：DoitPHP Group 更新日期：2010年9月25日 二、适用范围 如无特殊说明，以下规则要求完全适用于DoitPHP项目(注：Doitphp的PHP框架文件，而非使用DoitPHP所开发的PHP项目)。如果你喜欢以下编码规范，也可以用在其它PHP开发项目。 标准化的重要性和好处 “不以规矩，不成方圆”，当一个软件项目的开发遵守公共一致的标准时，整个团队成员形成并保持一致的编码风格，整个项目文件如同一人所写。每个程序员的代码都易于为他人所理解，提高了代码的可维护性，从而减少了软件的维护成本。同时使新的参与者可以很快的适应环境，从而最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成好的编码习惯，可以减少编码出错的机会,甚至锻炼出更加严谨的思维。将规范“令之以文”是为了明确我们的编码标准。我们相信：标准不是项目成功的关键，但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。 PHP编码规范与原则 文件格式 1.1、文件编码：文件编码统一为UTF-8(注:非UTF-8+BOM)。 1.2、PHP代码标记任何时候都要使用本缩进规范适用于JavaScript中的函数、类、逻辑结构、循环等除了语言包注释配置文件,其它地方不能有中文为了便于理解，使用下划线分割每个单词常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。文件头的注释声明在文件开始的时候，你必须加入以下的注释声明：while，: ?)： /*正确*/ If ($a $b) { echo $a, 大于, $b; } else { echo $a, 不大于, $b; } /*错误*/ if($a $b) { echo $a, 大于, $b; } else { echo $a, 不大于, $b; } /*错误*/ if($a $b) echo $a, 大于, $b; else echo $a, 不大于, $b; /*推荐*/ echo ($a $b) ? $a.大于.$b : $a.不大于.$b; 在if结构中，在关键字（如if ）后面要空一个格，然后再跟控制的括号函数调用对于函数调用，函数名和左括号(”之间不应该有空格，对于函数参数必须用 逗号+空格 来分隔，最后一个参数和右括号之间不能有空格。下面是一个标准的函数调用 $result = foo($param1, $param2, $param3); /* 不正确 */ $result=foo ($param1,$param2,$param3); $result=foo( $param1,$param2, $param3 ); 此外，如果要将函数的返回结果赋值，那么在等号和所赋值的变量之间要有空格，同时，如果是一系列相关的赋值语句，你添加适当的空格，使它们对齐$result1 = $foo($param1, $param2, $param3); $var2 = $foo($param3); $var3 = $foo($param4, $param5); 3.10、函数定义： 左大括号“｛”必须与函数名同行。推荐“｛”与函数名间隔一空格，这样代码更加清晰。函数定义中的左括号“（”，与函数名紧挨，中间无需空格。 函数参数的名字和变量的命名规范一致,参数必须用逗号+空格来分隔。具有默认值的参数应该位于参数列表的后面。若具有默认值的参数数据类型不为boolean时，默认值为空时不允许用false,而是用null。 引用只允许定义在函数参数中，实时传递引用是禁止的。其实“”引用,我们是非常不推崇的，这样会给别人阅读、理解代码无端地增加了难度。 左右小括号(),与参数紧贴，不允许有空格。函数返回值不可以用括号包住，这样做除了增加阅读代码时不必要的麻烦外，没有其它益处。如外必须仔细检查并切实杜绝函数起始缩进位置与结束缩进位置不同的现象。 /* 正确 */ function 函数名(参数1, 参数2, 参数3) ｛ .... ｝ /* 错误 */ function 函数名(参数1,参数2,参数3)｛ .... ｝ 3.11、类的定义： 左大括号{必须与类名同行，且与类名间隔一空格。 /*正确*/ class demo { ... } /*错误*/ class dem