读书人

PHP 编码轨范

发布时间: 2012-10-18 13:46:55 作者: rapoo

PHP 编码规范

为了让我们的代码更具可读性以及维护性,同时也为了少写注释,我们希望通过规范的命名以及代码的书写达到 "Code as Document" 的目的。翼高电子商务系统中所有的 PHP 文件必须遵循该文档中规定的编码规范。同时,我们在SVN的服务器端增加了规范检查,如提交的代码中存在不符合规范的代码,SVN会返回错误提示。请仔细阅读SVN的错误提示,提示中会有详细的出错文件、行数以及不符合规范的描述。

对于第三方的类库,如有必要请和项目管理人联系。

编辑器设置
    代码缩进:所有的缩进使用空格取代Tab制表符,每一个缩进含有 4 个空格。文件编码:所有PHP文件均保存为 UTF-8 ( No BOM )的字符编码,不允许使用 ANSI 。
命名约定变量命名

变量名已驼峰方式进行命名,首字母小写,之后的单词的首字母大写。例如:

$currentUser 是正确的, 但是 $currentuser$current_user 就不正确。
$requestUrl 是正确的, 但是 $requestURL 就不正确。

名称应当是描述性的,并且简明。我们自然不希望使用冗长的句子作为变量名,但是多输入几个字符总好于疑惑于某个变量到底是干什么用的。

常量命名

常量命名采用全部大写字母以及下划线(_)组成,例如 ORDER_TYPE。

循环计数器

允许使用一个单字符变量名的唯一情形是当它作为一个循环计数器的时候。在这种情况下,外层循环的计数器应当始终是 $i。如果有一个循环处于这个循环的内部,它的计数器应当是 $j,进而是 $k,等等。如果循环的计数器是一个已经存在并且名字有意义的变量,本规范并不适用。

 // 通常的写法 if ($a == $b) {     $c = 'foo';}  // 简写的方式 $a == $b && $c = 'foo';

读书人网 >PHP

热点推荐