专栏首页技术博文PHP编程风格规范

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

#正确

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值前后必须加单引号。

#正确

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 '';
}

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • linux命令总结

    cat tail -f 日 志 文 件 说明 /var/log/message 系统启动后的信息和错误日志,是Red Hat Linux中最常用的日志之一...

    joshua317
  • php 实现文件下载

    1、php下载原理图 ? 2、文件下载源码: 1 <?php 2 $file_name="umiwi.apk";//需要下载的文件 3 $file_dir...

    joshua317
  • file_put_contents— 将一个字符串写入文件

    将字符串写入到文件中,我们可以用fwrite写文件函数进行操作,今天写程序的时候,突然觉得其实file_put_contents()函数,用来写入字符串,后来仔...

    joshua317
  • 会欺负行人?旧金山出台政策限制快递机器人上路

    【环球智能12月8日报道 记者 心月】随着科技的发展,快递物流业也在向高科技方向发展,物流无人机、送货机器人早已屡见不鲜了。这些送货机器人一般使用传感器以及类似...

    企鹅号小编
  • SAP NetWeaver远程代码执行漏洞来袭 安恒信息提醒用户及时关注并防护

    SAP NetWeaver 是基于专业标准的集成化应用平台,能够大幅度降低系统整合的复杂性。其组件包括门户、应用服务器、商务智能解决方案以及系统整合和数据整合技...

    安恒信息
  • R语言实现多种图像格式导出再编辑

    不知道大家在为自己的文章绘图的时候总觉得不是那么完美。老是想自己手动改改,可是呢,AI呀PS呀又是一塌糊涂。今天我就为大家介绍一个可以讲R语言绘制的图形直接导入...

    一粒沙
  • 将PB级数据传输到云端的四个步骤

    如今,各种组织正在越来越多地使用公共云基础设施,但是人们发现将数百TB或PB数据向云端的迁移比想像得更复杂,更具破坏性,并且不具备灵活性。 ? 云存储的商业价...

    静一
  • 字节码也能做有趣的事之ASM

    本篇是本系列的第二篇,主要介绍什么是ASM,以及如何使用ASM。 如果没有阅读之前的,还请阅读一下字节码也能做有趣的事,因为需要上一章的部分知识。

    用户5397975
  • 课时29:文件:一个任务

    (3)文件中总共有三段对话,分别保存为boy_1.txt, girl_1.txt,boy_2.txt, girl_2.txt, boy_3.txt, gril_...

    py3study
  • 容器服务:来自外部的问好!

    容器服务正在改变应用程序的部署方式和管理方式。但容器服务究竟是什么?它与其他传送平台方式有何不同?

    O小鸥

扫码关注云+社区

领取腾讯云代金券