当前位置：首页 > PHP教程 > php应用 > 列表

PHP编程风格规范分享

发布:smiling　来源: PHP粉丝网 　添加日期：2020-08-26 21:04:51　浏览: 评论：0　

本规范由 EasyChen 借鉴 SINA网络应用开发部《C++开发规范》和互动技术部《PHP4开发规范》，以及phpDocument规范 整理出的开发规范。我觉得非常不错, 适合PHP的开发，给大家参考，养成一个良好的编程风格是非常有必要的

说明：本规范由 EasyChen 借鉴 SINA网络应用开发部《C++开发规范》和互动技术部《PHP4开发规范》，以及phpDocument规范 整理出的开发规范。我觉得非常不错, 适合PHP的开发，给大家参考，养成一个良好的编程风格是非常有必要的。

第1章 命名规范

1.1变量

1.1.1全局变量

全局变量使用$g_开头，如$g_data_list。

1.1.2 一般变量

一般的变量使用小写字母命名，单词之间使用下划线分隔。

变量名字应该使用名词或者形容词+名词的方式。如$value，$new_value。

1.1.3 临时变量

不要将在循环中频繁使用的临时变量如$i、$j等用于其它用途。

1.2 函数

函数采用小写字母命名，单词之间使用下划线分隔。

函数的命名建议使用动词+名词的方式，如get_user_img。

完成一组功能的函数放到一个文件中，存放函数的文件采用function_name.func.php命名。

1.3 类

类使用英文的大小写来分隔单词，包括首个单词，所有单词的首字母大写，如PageManager；

在类中，方法放到属性定义前边、公用方法放到专用方法前边；

一般情况下，一个类对应到一个文件；

当一些类关系紧密时，可以存放在一个文件中；

存放类的文件采用ClassName.class.php方式命名。

1.4 方法

方法使用英文的大小写来分隔单词，除首个单词外，其他单词的首字母大写，如getCurrentPage()；

不要采用不常用的缩写，如where2go()；

使用常用的缩写时，只大写首字母，如getHtml()。

第2章 版式规则

2.1 语义分隔

各个函数、方法之间应该采用空行间隔；

同一个函数中联系紧密的语句之间可以不换行，其他情况需要换行。

2.2 空格规则

2.2.1 逻辑运算符前后必须加空格

正确，代码如下:

$a == $b;

错误，代码如下:

$a==$b;

$a ==$b;

正确，代码如下:

$a++; $a--;

错误，代码如下:

$a ++; $a --;

备注 加一减一运算符不能加空格。

2.2.2 多个参数分隔时必须加空格

正确，代码如下:

$g_pro , $g_user , g_show; 

get_db_info($host, $user, $passwd);

错误，代码如下:

$g_pro,$g_user,$g_show; 

get_db_info($host,$user,$passwd);

2.2.3 语法关键字后必须加空格

例如：If, for , while, switch …..

正确，代码如下:

for ($i = 0; $i < 10; $i++)

错误，代码如下:

for($i = 0; $i < 10; $i++ )

2.3 字符串和变量连接规则

字符串与变量连接使用'.'号时，必须在'.'前后加空格，使用"号时，必须在变量前后加"{}"。

正确，代码如下:

$my_name = 'file_' . $var1; 

$my_name = "file_{$var1}";

错误，代码如下:

$my_name = "file_'.$var1; 

$my_name = "file_$var1";

2.4 圆括号规则

函数名后括号不需要加空格、语法关键字后的括号必须加空格。

正确，代码如下:

  1. for ($i = 0; $i < 10; $i++)   
  2. strlen($my_name);  

错误，代码如下:

  1. for($i = 0; $i < 10; $i++ )   
  2. strlen ($my_name); 

2.5 花括号规则

花括号必须为上下对应。

正确，代码如下:

  1. if ($a)   
  2.  {   
  3.     $b = $a;   
  4.  }  

错误，代码如下:

  1. if ($a){   
  2.      $b = $a;   
  3.  }  

2.6 数组定义规则

数组定义和使用时中key值前后必须加单引号。

PHP 代码:

正确，代码如下:

array( 'name'   => '', 'gender'  => '' );   

$user_info['name'];

错误，代码如下:

  1. array( name => '', gender    => '' );    
  2. $user_info[name]; 

2.7 SQL规则

在PHP中嵌入的SQL语句关键字全部采用大写；

表名和字段名要用反引号(`)引起来以防止因为字段名中包含空格而出现错误；

数据值两边用单引号''包括，并且应确保数据值中的单引号已经转义以防止SQL注入。

正确，代码如下:

$sql = "SELECT `user`.`name` FROM `user` WHERE `id` = '$id' LIMIT 1";

错误，代码如下:

$sql = "select name.user from name where id = $id ";

第3章 注释规则

3.1 一般规则

不写不必要的注释；只有当代码不能很好地说明逻辑时，才用注释补充；

把注释看成程序的一部分，在编写/维护代码时同时编写/维护注释；

注释完全采用PHPDocumentor的规范，以方便用其生成API级文档。

3.2 详细规则

请参见PHPDocumentor手册。下边给出各个部分的注释示范。

3.2.1 版权信息

注释名称 版权信息

注释示范：

代码如下:

  1. // 
  2. // +----------------------------------------------------+ 
  3. // | phpDocumentor | 
  4. // +----------------------------------------------------+ 
  5. // | Copyright (c) 2000-2003 Joshua Eichorn | 
  6. // | Email jeichorn@phpdoc.org | 
  7. // | Web http://www.phpdoc.org | 
  8. // +----------------------------------------------------+ 
  9. // | This source file is subject to PHP License | 
  10. // +----------------------------------------------------+ 
  11. // 

备注 使用//来标示版权信息，以免和PHPDocumentor的page-level DocBlock发生冲突

3.2.2文件头注释示例

注释名称 文件头注释

注释示范：

  1. /** 
  2. * All abstract representations of inline tags are in this file 
  3. * @package phpDocumentor 
  4. * @subpackage InlineTags 
  5. * @since separate file since version 1.2 
  6. * @version $Id $ 
  7. */ 

备注

1）文件头注释需要指明所属的包和子包；

2）在@version中加上$ID，以方便使用CVS管理文件。

3.2.3 类注释示例

注释名称 类注释

注释示范：

PHP 代码:

  1. /** 
  2. * Use this element to represent an {@}inline tag} like {@}link} 
  3. * @see parserStringWithInlineTags 
  4. * @package phpDocumentor 
  5. * @subpackage InlineTags 
  6. * @author Greg Beaver <cellog@users.sourceforge.net> 
  7. * @since 1.0rc1 
  8. * @version $Revision: 1.21.2.6 $ 
  9. * @tutorial inlinetags.pkg 
  10. */ 

3.2.4 类属性注释示例

注释名称 类属性注释

注释示范：

PHP 代码:

  1. /** 
  2. * Element type 
  3. * 
  4. * Type is used by many functions to skip the hassle of 
  5. * 
  6. * <code> 
  7. * if get_class($blah) == 'parserBlah' 
  8. * </code> 
  9. * always "inlinetag" 
  10. * @var string 
  11. */ 
  12. var $type = 'inlinetag'; 

3.2.5 函数/类方法注释示例

注释名称 函数/类方法注释

注释示范：

  1. /** 
  2. * @return string always '' 
  3. * calculate the short description of a DocBlock 
  4. * @see parserStringWithInlineTags::getString() 
  5. * @see parserStringWithInlineTags::trimmedStrlen() 
  6. */ 
  7. function getString() 
  8. { 
  9.  return ''; 
  10. } 

Tags: PHP编程风格规范

分享到：

推荐文章

热门文章

最新评论文章