PHP 代码规范小结

命名规范

  Θ 类文件都以.class.php为后缀,使用驼峰法命名,并且首字母大写,例如 Pay.class.php;

  Θ 类名和目录_文件名一致。例如:类名Zend_Autoloader的目录是Zend/Autoloader.class.php;

  Θ 函数的命名使用小写字母和下划线的方式。例如:get_client_ip;

  Θ 方法的命名使用驼峰法,首字母小写或者使用下划线"_",例如listComment(),_getResource(),通常下划线开头的方法属于私有方法;

  Θ 属性的命名使用驼峰法,首字母小写或者使用下划线"_",如$username,$_instance,通常下划线开头的属性属于私有属性;

  Θ 常量以大写字母和下划线"_"命名,如"HOME_URL";

  常用名词

  1>list名词(单数),如listApple,一看我们就知道读取苹果列表,我们没有必要写成getApples或者listApples或readApples——因为get我们规定一般用于读取单个数据,如getApple.listApples不加s我们也知道是取苹果列表(保证尽量缩短变量命名);

  2>get名词(单数);

  3>名词Total,表示某个东西的总数。如expenseTotal;

  4>found:表示某个值是否已经找到;

  5>uccess或ok:一项操作是否成功;

  6>done:某个工程是否完成;

  7>error:是否有错误发生;

  8>result:返回的结果

  代码重构

  1.函数或者方法体内的代码尽量控制在一个屏幕内。

  2.类中不使用的方法随机删除。

  3.修改别人的类中方法,要签名。

  4.在每个模块内写个readme文件(用于比较复杂业务的说明或代码说明)。

  5.尽量让每个类做自己的事,每个函数做一件事。

  常用代码

  用&&或||简化操作

  简化前:

  

复制代码 代码如下:

  $a=1;

  $b = 0;

  if(isset($a)){

  $b=1;

  print($b."\n");

  }

  if($b!=0){

  print($b."\n");

  }

  简化后:

  

复制代码 代码如下:

  $a=1;

  $b = 0;

  isset($a) && ($b=1) && print($b."\n");

  $b == 0 || print($b."\n");

  明显代码看起来更加整齐,更加简单!

  判断"=="时,把常量放在前面

  之前:

  

复制代码 代码如下:

  $a = 1;

  if($a = 1){

  echo '$a == 1';

  }

  之后:

  

复制代码 代码如下:

  $a = 1;

  if(1 = $a){

  echo '$a == 1';

  }

  明显,常量放在前面的话,编译器就能判断错误。

  正规格式:

  

复制代码 代码如下:

  $a = 1;

  if(1 == $a){

  echo '$a == 1';

  }

  查找表法

  之前:

  

复制代码 代码如下:

  /*错误码:4,5,7,8的时候返回状态1,错误码是1,3,6返回状态2*/

  $error = 4;

  $state = 0;

  if($error == 4 || $error == 5 || $error == 7 || $error == 8){

  $state = 1;

  }

  if($error == 1 || $error == 3 || $error == 6){

  $state = 2;

  }

  echo "$state \n";

  之后:

  

复制代码 代码如下:

  /*错误码:4,5,7,8的时候返回状态1,错误码是1,3,6返回状态2*/

  $error = 4;

  $state = 0;

  $arr = array(4 => 1, 5 => 1, 7 => 1, 8 => 1, 1 => 2, 3 => 2, 6 => 2);

  isset($arr[$error]) && ($state = $arr[$error]);

  echo "$state \n";

  明显代码更加凝练,更加清楚,更易懂,速度也更快!

  总结

  本来想把什么设计模式也往常用代码里放置,但是太多了,不太好放。这些只是微部而已!

  大家如果有更好的写法的话,可以留言。