当前位置:首页 > PHP教程 > php高级应用 > 列表

PHP编程之代码命名规范

发布:smiling 来源: PHP粉丝网  添加日期:2014-06-14 12:49:14 浏览: 评论:0 

文件名:一律小写,单词间以下划线分隔

类名:采用首字母大写的驼峰命名方式

类中的方法名:采用首字母小写的驼峰方式命名

类中的私有方法和私有变量:以下划线开头

函数名(变量名):全小写,单词间以下划线分隔

下面具体介绍

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

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

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

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

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

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

理解一下消化一下:

1.缩进及行的长度

缩进4个空格,而不是tab(有些编辑器可以配置一个tab代表多个空格,注意是空格),每行保持大约75-85个字符的长度.

2.控制结构

这个部分最容易忽略,也是影响代码美感最重要的方面,例子很详细了,受益匪浅,代码如下:

  1. <?php 
  2. if ((condition1) || (condition2)) { 
  3.     action1; 
  4. elseif ((condition3) && (condition4)) { 
  5.     action2; 
  6. else { 
  7.     defaultaction; 
  8. ?> 
  9. <?php 
  10. switch (condition) { 
  11. case 1: 
  12.     action1; 
  13.     break
  14.  
  15. case 2: 
  16.     action2; 
  17.     break
  18.  
  19. default
  20.     defaultaction; 
  21.     break
  22. ?> 
  23.  
  24. <?php 
  25.  
  26. if (($condition1 
  27.     || $condition2
  28.     && $condition3 
  29.     && $condition4 
  30. ) { 
  31.     //code here 
  32. ?> 
  33.  
  34. <?php 
  35.  
  36. $a = $condition1 && $condition2 
  37.     ? $foo : $bar
  38.  
  39. $b = $condition3 && $condition4 
  40.     ? $foo_man_this_is_too_long_what_should_i_do 
  41.     : $bar
  42. ?> 

3.函数调用,代码如下:

  1. <?php 
  2. $var = foo($bar$baz$quux); 
  3. $short         = foo($bar); 
  4. $long_variable = foo($baz); 
  5. ?> 

4.类名规范,代码如下:

  1. <?php 
  2. class Foo_Bar 
  3.  
  4.     //... code goes here 
  5.  
  6. ?> 

5.方法名规范(驼峰命名),代码如下:

  1. <?php 
  2. function fooFunction($arg1$arg2 = ''
  3.     if (condition) { 
  4.         statement; 
  5.     } 
  6.     return $val
  7. ?> 

6.数组定义规范,代码如下:

  1. <?php 
  2. $some_array = array
  3.     'foo'  => 'bar'
  4.     'spam' => 'ham'
  5. ); 
  6. ?> 

7.注释

http://pear.php.net/manual/en/standards.sample.php

http://pear.php.net/manual/en/standards.header.php

8.Including Code

任何时候都应该采用include_once或者require_once

require_once 'foo.php'

Tags: PHP编程 代码命名规范

分享到:

相关文章