PHP编程风格规范分享


Posted in PHP onJanuary 15, 2014

说明:本规范由 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 圆括号规则
函数名后括号不需要加空格、语法关键字后的括号必须加空格。
正确

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 代码:
正确

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

错误

array( name => '', gender    => '' );   
$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 版权信息
注释名称 版权信息
注释示范:

//
// +----------------------------------------------------+
// | phpDocumentor |
// +----------------------------------------------------+
// | Copyright (c) 2000-2003 Joshua Eichorn |
// | Email jeichorn@phpdoc.org |
// | Web http://www.phpdoc.org |
// +----------------------------------------------------+
// | This source file is subject to PHP License |
// +----------------------------------------------------+
//

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

3.2.2文件头注释示例

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

PHP 代码:

/**
* All abstract representations of inline tags are in this file
* @package phpDocumentor
* @subpackage InlineTags
* @since separate file since version 1.2
* @version $Id $
*/

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

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

PHP 代码:

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

3.2.4 类属性注释示例
注释名称 类属性注释
注释示范:
PHP 代码:

/**
* Element type
*
* Type is used by many functions to skip the hassle of
*
* <code>
* if get_class($blah) == 'parserBlah'
* </code>
* always "inlinetag"
* @var string
*/
var $type = 'inlinetag';

3.2.5 函数/类方法注释示例
注释名称 函数/类方法注释
注释示范:
PHP 代码:

/**
* @return string always ''
* calculate the short description of a DocBlock
* @see parserStringWithInlineTags::getString()
* @see parserStringWithInlineTags::trimmedStrlen()
*/
function getString()
{
 return '';
}
PHP 相关文章推荐
mysql建立外键
Nov 25 PHP
PHP5中新增stdClass 内部保留类
Jun 13 PHP
用php随机生成福彩双色球号码的2种方法
Feb 04 PHP
PHP JSON格式的中文显示问题解决方法
Apr 09 PHP
PHP实现带重试功能的curl连接示例
Jul 28 PHP
PHP实现判断数组是一维、二维或几维的方法
Feb 06 PHP
php魔法函数与魔法常量使用介绍
Jul 23 PHP
PHP实践教程之过滤、验证、转义与密码详解
Jul 24 PHP
php微信开发之谷歌测距
Jun 14 PHP
php微信公众号开发之答题连闯三关
Oct 20 PHP
浅析PHP 中move_uploaded_file 上传中文文件名失败
Apr 17 PHP
小程序微信支付功能配置方法示例详解【基于thinkPHP】
May 05 PHP
php object转数组示例
Jan 15 #PHP
windows下PHP_intl.dll正确配置方法(apache2.2+php5.3.5)
Jan 14 #PHP
PHP类继承 extends使用介绍
Jan 14 #PHP
那些年我们错过的魔术方法(Magic Methods)
Jan 14 #PHP
PHP mail()函数使用及配置方法
Jan 14 #PHP
PHP 登录完成后如何跳转上一访问页面
Jan 14 #PHP
PHP四舍五入精确小数位及取整
Jan 14 #PHP
You might like
ThinkPHP Mobile使用方法简明教程
2014/06/18 PHP
微信access_token的获取开发示例
2015/04/16 PHP
php代码架构的八点注意事项
2016/01/25 PHP
php自定义函数实现JS的escape的方法示例
2016/07/07 PHP
postfixadmin忘记密码后的修改密码方法详解
2016/07/20 PHP
在JavaScript中实现类的方式探讨
2013/08/28 Javascript
javascript对象的使用和属性操作示例详解
2014/03/02 Javascript
js delete 用法(删除对象属性及变量)
2014/08/24 Javascript
JS在可编辑的div中的光标位置插入内容的方法
2014/11/20 Javascript
js使用心得分享
2015/01/13 Javascript
用svg制作富有动态的tooltip
2015/07/17 Javascript
详解JavaScript编程中的数组结构
2015/10/24 Javascript
canvas快速绘制圆形、三角形、矩形、多边形方法介绍
2016/12/29 Javascript
js中less常用的方法小结
2017/08/09 Javascript
node简单实现一个更改头像功能的示例
2017/12/29 Javascript
node.js通过axios实现网络请求的方法
2018/03/05 Javascript
JavaScript动态检测密码强度原理及实现方法详解
2019/06/11 Javascript
vue项目配置 webpack-obfuscator 进行代码加密混淆的实现
2021/02/26 Vue.js
[43:48]Ti4正赛第一天 VG vs NEWBEE 2
2014/07/19 DOTA
[01:00:49]DOTA2-DPC中国联赛 正赛 Ehome vs iG BO3 第二场 1月31日
2021/03/11 DOTA
使用python分析统计自己微信朋友的信息
2019/07/19 Python
Python如何输出整数
2020/06/07 Python
Python调用C/C++的方法解析
2020/08/05 Python
Python try except else使用详解
2021/01/12 Python
Python使用cn2an实现中文数字与阿拉伯数字的相互转换
2021/03/02 Python
美国专业汽车音响和移动电子产品零售商:Car Toys
2019/05/13 全球购物
医学院毕业生自荐信
2013/11/08 职场文书
大学生社会实践方案
2014/05/11 职场文书
装饰公司活动策划方案
2014/08/23 职场文书
餐厅感恩节活动策划方案
2014/10/11 职场文书
通知函格式范文
2015/04/27 职场文书
2015年世界急救日宣传活动方案
2015/05/06 职场文书
2015年初三班主任工作总结
2015/05/21 职场文书
Python中X[:,0]和X[:,1]的用法
2021/05/10 Python
java如何实现socket连接方法封装
2021/09/25 Java/Android
Win10系统搭建ftp文件服务器详细教程
2022/08/05 Servers