PHP编程规范

第1章 命名规范

1.1变量

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

1.1.2 静态变量

静态变量使用$s_开头，如$s_value.

1.1.3 引用变量

引用变量使用$r_开头，如$r_var.

1.1.4 一般变量
一般的变量使用小写字母命名，单词之间使用下划线分隔。
变量名字应该使用名词或者形容词+名词的方式。如$value，$new_value。

1.1.5临时变量
不要将在循环中频繁使用的临时变量如$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 圆括号规则
函数名后括号不需要加空格、语法关键字后的括号必须加空格。

正确 for ($i = 0; $i < 10; $i++)
strlen($my_name);
错误 for($i = 0; $i < 10; $i++ )
strlen ($my_name);
备注 -

2.5 花括号规则
花括号必须为上下对应。

正确 
if  ($a)
{
$b = $a;
}

错误 if  ($a){
$b = $a;
}

备注 -

2.6 数组定义规则

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

PHP 代码:

1. <?php
2. //正确
3. array(
4.     'name'        => 'd5s.cn',
5.     'gender'    => 'php'
6. );
7. //错误
8. array(
9.     name    => 'd5s.cn',
10.     gender    => 'php'
11. );
12. ?>

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 版权信息
注释名称 版权信息
注释示范 //
// +—————————————————-+
// | phpDocumentor |
// +—————————————————-+
// | Copyright (c) 2000-2003 Joshua Eichorn |
// | Email 2332460688@qq.com |
// +—————————————————-+
// | This source file is subject to PHP License |
// +—————————————————-+
//
备注 使用//来标示版权信息，以免和PHPDocumentor的page-level DocBlock发生冲突

3.2.2文件头注释示例 

注释名称 文件头注释
注释示范 

1. <?php
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. */
8. ?>

备注
1 文件头注释需要指明所属的包和子包
2 在@version中加上$ID，以方便使用CVS管理文件

3.2.3 类注释示例
注释名称 类注释
注释示范 p

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

备注 -

3.2.4 类属性注释示例
注释名称 类属性注释
注释示范 

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

备注 -

3.2.5 函数/类方法注释示例
注释名称 函数/类方法注释
注释示范 

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