php编写代码规范,php代码编写规范

文档注释

文档性的注释，是由3个部分组成的，分别是：功能简述区 ，功能详细说明区 ，文档标记区 。

classuser{.....}

功能简述区

第一行是一个注释开始的标志"",注意，在注释结束标记*/后面应该直接跟一个回车，不要另外附加其他的东西，否则可能造成PHPDOC分析出错。

编码规则

PEAR的编码规则包括缩进规则，控制结构，函数调用，函数定义，注释，包含代码，PHP标记。

命名规则

类名是个一名词，采用下划线+小写的方式。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词。(采用小写是为了保证windows和linux 文件名大小写不同,导致错误)

classuser;classadmin_user;

方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。

functionrun();functionrunFast();

第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。

float$myWidth;

缩进规则

PEAR中需要使用4个空格来缩排代码，并且不使用TAB。

换行规则

尽量避免一行的长度超过80个字符，在一个逗号后面断开或者在一个操作符前面断开。

控制结构

控制结构包括: if for while switch 等。对于控制结构，在关键字(如if for

..)后面要空一个格，然后再跟控制的圆括号，这样，不至于和函数调用混淆，此外，你应该尽量完整的使用花括号{}，即使从语法上来说是可选的。这样可以防止你以后需添加新的代码行时产生逻辑上的疑惑或者错误。

下面只是格式上的例子。

if($i==0){echo"Hello";}else{echo"World";}if($k==0){echo"test1";// if下面的内容缩进4空格}elseif($k>=3){echo"test2";}else{echo"test3";}for($j=0;$j<=10;$j++){echo $j;}while($m==9){echo"test1";}do{echo"alsdfjkl";}while($m==8);switch($n>=100){// 不知道为什么这个缩进就不好使,case没有缩进case20:echo"test20";case30:echo"test30";break;}

类定义

一定要注意写完整的class信息，其中 @category 和 @package 的第一个字母要大写

注意类的命名规则，测试中下划线也是可以的，如例子。

classtest{//  一定要空行var$startNum=100;var$endNum=60;functionshow($startNum,$endNum){$info=number($startNum);switch($info){// 不知道为什么这个缩进就不好使case'good':$endNum=$endNum*10;echo $endNum;case'bad':$endNum=$endNum*20;echo $endNum;break;}}functionnumber($startNum){if($startNum==100){$result='good';}else{$result='bad';}return$result;}}

函数定义

函数名和左括号(

之间不应该有空格，对于函数参数，在分隔的逗号和下一个参数之间要有相同的空格分离，最后一个参数和右括号之间不能有空格。

functiongetUserName($id){return $userName;}

函数调用

对于函数调用，函数名和左括号(

之间不应该有空格，对于函数参数，在分隔的逗号和下一个参数之间要有相同的空格分离，最后一个参数和右括号之间不能有空格。下面是一个标准的函数调用。

$result=foo($param1,$param2,$param3);

PHP代码标记

任何时候都要使用定义你的php代码，而不要简单地使用