最基本的PHP书写规范归纳如下:

n {}扩号换行原则:首括号与关键词同行,尾括号与关键字同列。首括号与之前的内容间有1个空格。

 

示例代码如下:

function get_clientip() {

if($_SERVER["HTTP_X_FORWARDED_FOR"]) {

$ip = $_SERVER["HTTP_X_FORWARDED_FOR"];

} elseif($_SERVER["HTTP_CLIENT_IP"]) {

$ip = $_SERVER["HTTP_CLIENT_IP"];

} else {

$ip = false;

}

return $ip;

}

 

n if结构中,if和elseif与前后两个圆括号同行,即便if后只有一行语句,仍然需要加入大括号,以保证结构清晰。

n 缩进排版原则:

所有的缩进使用空格取代Tab制表符。PHP文件采用4个空格的缩进,HTML文件以及HTML文件中嵌入的Javascript代码采用2个空格的缩进;单独的 Javascript以及CSS文件采用4个空格的缩进。需每个参与项目的开发人员在编辑器(UltraEdit、EditPlus、Zend Studio等)中进行强制设定,以防在编写代码时遗忘而造成格式上的不规范。

n 注释前面要空一行,这样注释才会被清楚的看到,注释后面一般直接跟下面的代码;

n 所有PHPHTML文件均保存为No Bom UTF-8的字符编码;

n 注释的写法:根据流行的注释写法我们要求对于代码段的注释采用以下的方式来书写:

/* 注释内容 */

对于单行的注释则使用下面的注释形式,注意在//之后有一个空格,例如:

define(‘IN_ECS’, ture); // 注释内容。

n =, >, <运算符需要左右各空一格;

n 其它运算符,如+, -, %等,可以左边不空格,右边空格,便于阅读;

n 方法和方法之前,就算没有注释,也是需要空一行的。最好是每个方法都写一个注释;

n 连字符.两侧各加一个空格;

n private变量,private方法最好以_(下划线开头);

return语句前面最好空一行。