首页 / PHP / PHP编程规范

PHP编程规范

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了PHP编程规范，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含5219字，纯文字阅读大概需要8分钟。

内容图文

一直以来我都是以php函数的风格来写php，所有变量，函数，类都使用小写，单词之间以下划线隔开，一直比较排斥驼峰式的代码规范，个人觉得在大小写字母之间的书写代码，很麻烦，而且PHP自己的函数都是小写，为什么我不用这种格式呢？

良好的代码书写习惯 + 良好的注释习惯 + PhpDocumentor = 程序说明书

一个团队，必须有整齐的代码书写习惯，如果再配上统一的IDE开发环境，详细的任务编码流程，完善的代码测试（如：SimpleTest），那么整个团队的开发效率将会有很大的提高。

如果你的IDE是Eclipse，那么你可以很方便的进行代码测试，使用SimpleTest参考http://www.guogoul.com/2008/05/19/simpletest_1/

说明：本规范由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 代码:

下载: php_array.php //正确
array(
'name' => ‘d5s.cn’,
‘gender’ => ‘php’
);
//错误
array(
name => ‘d5s.cn’,
gender => ‘php’
);
?>

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.2文件头注释示例

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

下载: php_doc.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_class.php /**
* Use this element to represent an {@}inline tag} like {@}link}
* @see parserStringWithInlineTags
* @package phpDocumentor
* @subpackage InlineTags
* @author Greg Beaver
* @since 1.0rc1
* @version $Revision: 1.21.2.6 $
* @tutorial inlinetags.pkg
*/
?>

备注 -

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

下载: php.php /** var $type = 'inlinetag';
* Element type
*
* Type is used by many functions to skip the hassle of
*
*
* if get_class($blah) == ‘parserBlah’
*
* always "inlinetag"
* @var string
*/
?>

备注 -

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

下载: php.php /** function getString() '';
* @return string always ''
* calculate the short description of a DocBlock
* @see parserStringWithInlineTags::getString()
* @see parserStringWithInlineTags::trimmedStrlen()
*/

{
return
}
?>

内容总结

以上是互联网集市为您收集整理的PHP编程规范全部内容，希望文章能够帮你解决PHP编程规范所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/193354.html

来源：【匿名】

【上一篇】PHP和MySQL入门（8）【下一篇】PHP 5 数据对象 (PDO) 抽象层与 Oracle

更多 ►

【PHP编程规范】教程文章相关的互联网学习教程文章

2020/2/5 php编程学习【图】

一事无成的上午。。就安了框架解决了一些报错信息下面简单了解一下安装一下框架：什么是路由：系统从URI（唯一资源定位器）参数中分析出当前请求的分组（平台），控制器和操作方法的过程就是路由。URL ：统一资源定位符 URI: 统一资源标识符 URL是URI的一个子集原文：https://www.cnblogs.com/wangtanzhi/p/12263110.html

PHP系统编程--02.PHP守护进程化【代码】

什么是守护进程?一个守护进程通常补认为是一个不对终端进行控制的后台任务。它有三个很显著的特征:在后台运行，与启动他的进程脱离，无须控制终端。常用的实现方式是fork() -> setsid() -> fork()在glibc里有一个函数daemon。调用此函数，就可使当前进程脱离终端变成一个守护进程，具体内容参见man daemon。PHP中暂时没有此函数，PHP程序实现守护进程化有2种方法：使用系统命令nohupnohup php myprog.php > log.txt &&，这样执行程...

PHP Socket编程之使用fsockopen()函数

PHPSocket编程Socket可以理解为两台计算机相互通信的通道。用法：使用fsockopen()函数具体用法详见上篇文章。函数的参数为URL、端口号、一个存放错误编号的变量、一个存放错误信息字符串的变量和超时等待时间。（只有第一个参数是必须的）常见的端口表：端口号主要用途21FTP22SSH23Telnet25SMTP80Web110POP其中，组成URl的几个部分为：协议名（scheme），主机（host），端口号（port），文件路径（path），查询参数（query）。当ur...

php多进程编程实现与优化【代码】

PHP多进程API创建子进程@params void @returns int int pcntl_fork(void) 成功时，在父进程执行线程内返回产生的子进程PID，在子进程执行线程内返回0，失败时，在父进程上下文返回-1，不会创建子进程，并且会引发一个php错误获取当前进程id@params void @returns int int posix_getpid(void) 返回进程id，类型为整型父进程等待子进程退出@params $status@params $option@return bool int pcntl_wait(int &$status[,int $options=0]...

PHP socket网络编程之使用curl

PHPsocket 网络编程之使用cURLcURl代表客户端URL，是一种专门处理URL的命令行工具。本文介绍cURl打开网页并向其提交数据。【示例】：cURL库被PHP用于向页面传递数据<?PHP//创建cURL事务$url = 'HTTP://localhost/service.php';$curl = curl_init($url);//如果发生错误，直接运行失败curl_setopt($curl,CURLOPT_FAILONERROR,1);//支持重定向curl_setopt($curl,CURLOPT_FOLLOWLOCATION,1);//设置是否将处理结果存入一个变量的选项cur...

提高PHP编程效率的20个要点

用单引号代替双引号来包含字符串，这样做会更快一些。因为PHP会在双引号包围的字符串中搜寻变量，单引号则不会，注意：只有echo能这么做，它是一种可以把多个字符串当作参数的“函数”(译注：PHP手册中说echo是语言结构，不是真正的函数，故把函数加上了双引号)。　 1、如果能将类的方法定义成static，就尽量定义成static，它的速度会提升将近4倍。 2、$row[’id’] 的速度是$row[id]的7倍。　　3、echo 比 print 快，并且...

PHP5权威编程阅读学习笔记附电子书下载

PHP 5 权威编程(PHP 5 Power Programming) PDF下载地址 http://www.jb51.net/books/28207.html PHP4中，不使用__construct()作为构造函数的名字，必须使用类的名字定义一个方法，就像在C++中一样。 PHP5中，使用新的统一的构造函数命名方式：__construct()，当然，使用类名同样也是可以的。但是，你如果两个同时使用的话，系统默认会使用__construct()的形式。复制代码代码如下:<?php class Person{ //PHP4中的方法 public func...

php编程零基础如何快速入门。门头沟编程

昨天遇到一个人，说知道thinktphp,不过几年前的事了。我先跟他讲了下，xyhcms后台功能，各个版块，以及数据库都介绍了一下。跟他说了一个功能现场实现，说了实现方法。然后上机操作，发现他表单提交、方法传值、页面传值、传值获取没有做，也不知道问。甚至input标签都不知道。这样的基础肯定面试很难通过。如果想快速入门要么看视频、要么报个培训班、要么找个人带。视频网站建议:php.cn原文：https://www.cnblogs.com/phpfangzh...

atitit.泛型编程总结最佳实践 vO99 java c++ c#.net php

atitit.泛型编程总结最佳实践 vO99 java c++ c#.net php\1. 泛型历史 1由来 12. 泛型的机制编辑 1机制 1编译机制 23. 泛型方法定义1::前定义 2标签... 2' ref='nofollow'>4. 泛型方法定义2::后定义，方法也需要加标签... 2meth(); 2' ref='nofollow'>5. 调用泛型方法::: cls.meth(); 26. //反回值为范型 27. 参考 3 1. 泛型历史泛型编程（Generic Programming）最初提出时的动机很简单直接：发明一种语言机制，能够帮助实现一个通...

9条PHP编程小知识及易犯的小错误

变量声明如果在一条语句中声明一个变量，如下所示：$var=‘value‘;编译器首先会求出语句右半部分的值，恰恰正是语句的这一部分常常会引发错误。如果使用的语法不正确，就会出现解析错误。解析错误例如，Parse error:解析错误，unexpected T_WHILE in c:program filesapache groupapachehtdocsscript.php on line 19每次确定了前一错误时，解析错误一个接一个地不断出现，PHP在第一个解析错误之后就停止执行脚本。而且，解析错误具...

php socket编程入门【代码】

服务端<?php /*** File name server.php* 服务器端代码* * @author guisu.huang* @since 2012-04-11* *///确保在连接客户端时不会超时set_time_limit(0); //设置IP和端口号$address = "127.0.0.1"; $port = 2046; //调试的时候，可以多换端口来测试程序！ /*** 创建一个SOCKET * AF_INET=是ipv4 如果用ipv6，则参数为 AF_INET6* SOCK_STREAM为socket的tcp类型，如果是UDP则使用SOCK_DGRAM */$sock = socket_create(AF_INET, SOCK_S...

PHP - 技术教程分类

PHP 教程 PHP 简介 PHP 安装 PHP 语法 PHP 变量 PHP echo/print PHP EOF(heredoc) PHP 数据类型 PHP 类型比较 PHP 常量 PHP 字符串 PHP 运算符 PHP If...Else PHP Switch PHP 数组 PHP 数组排序 PHP 超级全局变量 PHP While 循环 PHP For 循环 PHP 函数 PHP 魔术常量 PHP 命名空间 PHP 面向对象 PHP 测验 PHP 表单 PHP 表单验证 PHP 表单 - 必需字段 PHP 完整表单实例 PHP $_GET 变量 PHP $_POST 变量 PHP 多维数组 PHP 日期 PHP 包含 PHP 文件 PHP 文件上传 PHP Cookie PHP Session PHP E-mail PHP Error PHP Exception PHP 过滤器 PHP 7 新特性 PHP MySQL 简介 PHP MySQL 连接 PHP MySQL 创建数据库 PHP MySQL 创建数据表 PHP MySQL 插入数据 PHP MySQL 插入多条数据 PHP MySQL 预处理语句 PHP MySQL 读取数据 PHP MySQL Where PHP MySQL Order By PHP MySQL Update PHP MySQL Delete PHP ODBC AJAX 简介 AJAX PHP AJAX 数据库 AJAX 实时搜索 AJAX 投票 PHP Array PHP Calendar PHP cURL PHP Date PHP Directory PHP Error PHP Filesystem PHP Filter PHP FTP PHP HTTP PHP Mail PHP Math PHP Misc PHP MySQLi PHP PDO PHP String PHP Zip PHP Timezones PHP 图像处理 PHP RESTful PHP PCRE PHP 可用的函数 PHP Composer php 全部

PHP - 最热教程

php如何取出数组的前几个元素 PHP变量什么时候释放 PHP如何实现在数据库随机获取几条记录如何解决php base64解码乱码 php主要用于哪些领域 Laravel 批量插入(insert)数据六款国内优秀免费wordpress主题推荐 React如何从后端获取数据并渲染到前端？纯PHP实现定时器任务（Timer），php实现...php该如何安装pdo_mysql扩展

首页 / PHP / PHP编程规范

PHP编程规范

内容导读

内容图文

内容总结

内容备注

内容手机端

【PHP编程规范】教程文章相关的互联网学习教程文章

2020/2/5 php编程学习【图】

PHP系统编程--02.PHP守护进程化【代码】

PHP Socket编程之使用fsockopen()函数

php多进程编程实现与优化【代码】

PHP socket网络编程之使用curl

提高PHP编程效率的20个要点

PHP5权威编程阅读学习笔记附电子书下载

php编程零基础如何快速入门。门头沟编程

atitit.泛型编程总结最佳实践 vO99 java c++ c#.net php

9条PHP编程小知识及易犯的小错误

php socket编程入门【代码】

php设计模式介绍之编程惯用法【图】

2020/2/12 PHP编程学习

Android之网络编程利用PHP操作MySql插入数据（四）【代码】【图】

paip.编程语言方法重载实现的原理及python,php,js中实现方法重载

PHP - 相关标签

编程 - 相关标签

PHP - 技术教程分类

PHP - 最新教程

PHP - 最热教程