php编程规范和范例

1、排版

1.1：程序块要采用缩进风格编写，缩进一个tab位（约为8个空格）。

说明：由开发工具自动生成的代码需要手工修改整理。

1.2：相对独立的程序块之间、变量说明之后必须加空行。

示例：如下例子不符合规范。

if (!empty($var))

{

... // code

}

$var1 = 1;

$var2 = 2;

应如下书写

if (!empty($var))

{

    ... // code

}

$var1 = 1;

$var2 = 2;

1.3：不允许把多个短语句写在一行中，即一行只写一条语句。

示例：如下例子不符合规范。

$length = 0;  $width = 0;

应如下书写

$length = 0;

$width  = 0;

1.4：if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

示例：如下例子不符合规范。

if ($var == NULL) return;

应如下书写：

if ($var == NULL)

{

    return;

}

1.5：对齐只使用TAB键，不使用空格键。

说明：在程序编辑时，输入一个TAB键远比输入4个或者8个空格键方便快捷。

1.6：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。

1.7：程序块的分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

示例：如下例子不符合规范。

for (...) {

    ... // code

}

if (...)

    {

    ... // code

    }

funcation fun($var)

    {

    ... // code

    }

应如下书写。

for (...)

{

    ... // code

}

if (...)

{

    ... // code

}

funcation fun($var)

{

    ... // code

}

1.8：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是变量指针（如－>），后不应加空格。

说明：采用这种松散方式编写代码的目的是使代码更加清晰。

由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在php语言中括号已经是最清晰的标志了。

在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

示例：

(1) 逗号、分号只在后面加空格（如果逗号位于最后，则不需要加）。

$var = array(a, b, c);

(2)比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。

if ($time >= time())

a = b + c;

a *= 2;

a = b ^ 2;

(3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。

*p = 'a';        // 内容操作"*"与内容之间

flag = !isEmpty; // 非操作"!"与内容之间

p = &mem;        // 地址操作"&" 与内容之间

i++;             // "++","--"与内容之间

(4)"->"、"."前后不加空格。

p->id = pid;     // "->"指针前后不加空格

(5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。

if (a >= b && c > d)