文章教程

C.2代码编写规范

9/17/2020 9:26:54 PM 人评论 次浏览

C.2 代码编写规范

这里介绍的PHP代码编写规范包括程序注释规则、语句规则、空格空行规则、括号位置规则等,下面分别加以介绍。

❑注释规则:对整个程序文件的注释,必须说明文件名称、程序表述、开发人员、开发日期以及版本信息等,并且采用“/**/”多行注释的方式。如下所示。


/**

*@file:config.php

*@brife:程序描述信息

*@author:mike

*@date:2007-5-23

*@version:1.0

*/


❑每个函数、方法等开头部分必须说明功能、参数、返回值等。

❑赋值语句书写规则:在有等号的赋值(区别于自加或自减等的赋值方式)语句中,等号两边需要各加一个空格,此规则也适用于函数返回的赋值或连接赋值,如下所示。


$style='';


❑空格规则:程序中滥用空格是绝对不允许的。空格的滥用会导致程序可读性变得很差,使代码松散难看。为使程序语句紧凑,首先,for循环中的赋值可以不在等号两边加空格。其次,保持if、elseif、for、while等语句与其后的括号之间不存在空白字符,如空格等,括号内语句中的分号紧跟前一个语句,不要加空白字符,如空格等,但分号可以与下一个语句之间存在一个空白字符,或不加空格。保持括弧内的变量与运算符之间不存在空白,如下所示。


for($i=$begin;$i<$begin+$this->pagenum;$i++);


这一行代码不符合这里所介绍规则的PHP代码,因为for与其之后的(之间有空格,变量$i与运算符<之间存在空格,变量$i与自加符号之间也存在空格等,这都造成了代码松散,不易阅读。如下所示的代码也不符合规则。


if(empty($index))

{

//do something

}


在这段代码中,空格被滥用了。类似的情况,还包括函数名与其参数列表之间加了空格等。

❑括号位置规则:使用括号如“{}”或“()”包含的语句块(如:类定义、函数定义、for循环语句,if……else控制语句等),请将开始括号和结束括号分别放在新开始的一行,并且此行只有括号存在。一对开始括号和结束括号在列上要对齐,一对开始括号和结束括号之间的语句,必须以括号所在列为准向内增加缩进(以缩进4个字符为佳)。开始括号或结束括号紧接着语句是不允许的,如下所示的代码段不符合规则。


if($real==123){

$timer=$_POST['timer'];

if($type=='a'){

$tmp=jumps($timer);

}else{

$tmp=jumps("120");

}

}


这段代码中的括号完全没有对齐,给阅读程序带来极大不便,而且也不美观。这样写似乎节省程序长度,减少文件行数,但实际上,节省文件长度不应该在这里过多考虑,因为程序的可读性在这里才是最重要的。修改为如下所示的代码即可符合规则。


if($real==123)

{

$timer=$_POST['timer'];

if($type=='a')

{

$tmp=jumps($timer);

}

else

{

$tmp=jumps("120");

}

}


❑空行规则:程序开发员需要在一个功能代码块结束后的适当位置,添加一行空行,以增加程序的可读性。如在函数定义结束之后、函数内部的一个循环语句块结束后等加入一个空行。

再次强调一下,上面介绍的代码编写规则并不是标准,仅作为实际开发中的一个参考。

教程类别