首页 / PHP / [转自php中国]PHP编码规范

[转自php中国]PHP编码规范

内容导读

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

内容图文

版权属于原创所有。。。。。。。。。。。。。。。。
[转]PHP编码规范

比较详细的讲解了在程序编写中要注意的问题。
但规范只是一种习惯，而不是一种强制性的东西，你完全可以不服从它。但养成良好的代码书写习惯，

个人认为还是很有必要的
PHP 编码规范

原文：http://pear.php.com/manual/en/standards.php

翻译：廖宇雷
最后更新日期：2003/05/06

内容列表

缩进
控制结构
函数调用
函数定义
注释
包含代码
PHP 代码标记
头注释块
使用 CVS
例子 URLs
命名约定
--------------------------------------------------------------------------------

缩进

缩进使用4个空格，而不是 tab。如果你使用 Emacs 编辑 PEAR 代码，你应该设置 indent-tabs-mode

为 nil。下面是一个 mode hook 的示例，用于设置 Emacs 符合缩进标准（你必须确保在编辑 PHP 文件

时，这些设置发生作用）：

(defun php-mode-hook ()
(setq tab-width 4
c-basic-offset 4
c-hanging-comment-ender-p nil
indent-tabs-mode
(not
(and (string-match "/(PEAR|pear)/" (buffer-file-name))
(string-match ".php$" (buffer-file-name))))))

这里是同等效果的 vim 规则：

set expandtab
set shiftwidth=4
set softtabstop=4
set tabstop=4

--------------------------------------------------------------------------------

控制结构

控制结构包含 if、for、while、switch 等。这里有一个 if 语句的示例和一个 switch 语句的示例：

if 语句的示例：

CODE:

[Copy to clipboard]

if ((condition1) || (condition2)) {
action1;
} elseif ((condition3) && (condition4)) {
action2;
} else {
defaultaction;
}
?>

switch 语句的示例：

CODE:

[Copy to clipboard]

switch (condition) {
case 1:
action1;
break;
case 2:
action2;
break;
default:
defaultaction;
break;
}
?>

控制语句应该在控制关键词和开始的圆括号之间应该有一个空格，以此和函数调用进行区别。

强烈建议你总是使用花括号将控制结构各部分标识出来。即使是在技术上可以不使用花括号的地方。这

可以增加代码的可读性，同时避免在结构部分增加新行后引入逻辑上的错误。

原始代码：

CODE:

[Copy to clipboard]

if (condition)
return true;
else
return false;

修改后的代码：

CODE:

[Copy to clipboard]

if (condition)
do something; // 出现逻辑错误
return true;
else
return false;

正确的做法：

CODE:

[Copy to clipboard]

if (condition) {
do something;
return true;
} else {
return false;
}

--------------------------------------------------------------------------------

函数调用

调用函数时，函数名和开始的括号之间不应该有空白字符。参数和开始及结束的括号之间不应有空格。

而除第一个参数外，其他参数都应该用一个空格分隔。这里有一个示例：

CODE:

[Copy to clipboard]

$var = foo($bar, $baz, $quux);
?>

像上面的示例代码，赋值运算等号两边都应该使用一个空格。如果是相关的赋值运算，应该采用下面的

形式以提供更好的可读性：

CODE:

[Copy to clipboard]

$short = foo($bar);
$long_variable = foo($baz);
?>

--------------------------------------------------------------------------------

函数定义

按照“one true brace”约定声明函数：

CODE:

[Copy to clipboard]

function fooFunction($arg1, $arg2 = '')
{
if (condition) {
statement;
}
return $val;
}
?>

“one true brace”约定就是开始的花括号单独占一行，而不是跟在其他语句后面。

具有默认值的参数应该位于参数列表的后面（事实上 PHP 语言定义也要求如此）。如果适合，函数应该

总是返回一个有意义的值。这里有一个稍微长一点的示例：

CODE:

[Copy to clipboard]

--------------------------------------------------------------------------------

注释

类型（class）的联机文档应该符合 PHPDoc（类似于 JavaDoc）的约定。更多关于 PHPDoc 的信息可以

访问 http://www.phpdoc.de/ 获得。

此外，强烈鼓励使用非文档注释。一般性规则是对于那些容易忘记作用的代码添加简短的介绍性注释。

推荐使用 C 样式的注释（/* */）和标准 C++ 注释（//)，而不应该使用 Perl/shell 样式的注释（#）。

--------------------------------------------------------------------------------

包含代码

无论在什么地方无条件包含一个类型文件，应该使用 require_once()。如果有条件的包含一个类型文件

（例如使用工厂方法），应该使用 include_once()。使用两者中的任何一个都能够确保类型文件只包含

一次。它们共享一个文件列表，因此你不需要担心混淆他们 ?? 一个文件使用 require_once() 包含

后不会在 include_once() 中再一次被包含。

备注：include_once() 和 require_once() 是一个声明，而不是函数。你不需要使用圆括号将文件名扩

起来（不过使用括号也不会出现错误）。

--------------------------------------------------------------------------------

PHP 代码标记

总是使用来界定 PHP 代码，而不要使用速记方式。这是为了符合 PEAR 一致性所必

须的，同时也是在不同操作系统和不同安装设置环境下移植 PHP 代码所要求的。

--------------------------------------------------------------------------------

头注释块

PEAR 发布的所有源代码文件头部都应该包含下面的注释块：

CODE:

[Copy to clipboard]

/* vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP version 4 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2002 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.com/license/2_02.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.com so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Authors: Original Author |
// | Your Name |
// +----------------------------------------------------------------------+
//
// $ Id $
?>

这里没有硬性规定要将一个代码贡献者的名字添加到文件注释的作者列表中。一般情况下，他们的更改

属于“substantial”目录（意味大约10%到20%的代码被改写）。有一个例外就是代码贡献者重写了函数

或者贡献了新的程序逻辑。

简单的代码重组和 bug 修复不应该增加新作者，这是不恰当的。

不在核心 PEAR 仓库中的文件应该有一个类似的注释块来说明版权、许可协议和作者。所有文件应该包

含一个模式行（modeline，用于 vim 和 emacs）以确保一致性。

--------------------------------------------------------------------------------

使用 CVS

这个小节的内容仅仅适用于 cvs.php.com 上使用 CVS 的包。

在每一个文件中包含 $Id $（两个 $ 符号之间的关键字不能够有空格，但由于此文档也是用 CVS 管理

，因此只好加个空格，避免被 CVS 替换掉） CVS 关键字，以便查看文件当前状态和最后修改时间等信

息。如果已经存在“Last Modified:”这样的信息，则替换为 $Id $ 标记。

这个小节的其他内容假定你有关于 CVS 标记和分支（branches）的基本知识。

CVS 标记用于标识你包中的文件释放之前所作的修订。下面的列表是必需使用和建议使用的 CVS 标记：

RELEASE_n_n

（必需的）用于标记一个释放版本。如果你没有使用这个标记，别人就没有办法在你发布一个释放版本

时从 CVS 服务器获取你的包。

QA_n_n

（分支，可选）如果你觉得在发布释放版本之前要提供一个候选释放版本，那么一个好主意就是增加一

个分支。这个分支可以让你将释放版本隔离出来，并在正式发布释放版本之前可以为这些分支单独应用

更新。期间，正常的开发工作可以在主干上继续进行。

MAINT_n_n

（分支，可选）如果你需要创建一个较小修改的释放版本（例如在 1.2 之后发布 1.2.1）。那么你可以

创建一个分支来达到目的。

仅有 RELEASE 标记是必须的，其他标记为了方便推荐你使用。

下面是一个如何为 "Money_Fast" 包 1.2 释放版本增加标记的示例：

$ cd pear/Money_Fast
$ cvs tag RELEASE_1_2
T Fast.php
T README
T package.xml

经过上面的操作，就可以在 PEAR Web 网站上获取你的一系列释放版本了。

这里是一个如何建立 QA 分支的示例：

$ cvs tag QA_2_0_BP
...
$ cvs rtag -b -r QA_2_0_BP QA_2_0
$ cvs update -r QA_2_0
$ cvs tag RELEASE_2_0RC1
...and then the actual release, from the same branch:
$ cvs tag RELEASE_2_0

"QA_2_0_BP" 标记是一个 "branch point" 标记，用于标记分支的开始。总是用这样的标记来标明分支

的开始是一个好主意。MAINT 分支可以使用 RELEASE 标记作为它的分支起点。

--------------------------------------------------------------------------------

示例中的 URL

所有示例中用到的 URL 地址都应该是 "example.com"、"example.org"、"example.net"。

--------------------------------------------------------------------------------

命名约定

一般而言，class、函数和变量的名字应该总是能够描述让代码阅读者能够容易的知道这些代码的作用。

Classes

class 应该具有一个描述性的名字。可能时应该避免使用缩写。class 名字应该总是用一个大写字母开

始。从 class 名字中也能够反映出 PEAR class 的层次。层次中的每个级别都用下划线进行分隔。好的

class 名字示例如下：

Log
Net_Finger
HTML_Upload_Error

函数和方法

函数和方法应该使用 "studly caps" 样式命名。函数应该将所在包的名字作为前缀，以避免与其他包的

函数发生名字冲突。名字的受字母（前缀之后）应该是小写，每一个新单词应该以大写字母开头。下面

是一些示例：

connect()
getData()
buildSomeWidget()
XML_RPC_serializeData()

私有 class 成员和属性（意味着 class 成员和属性只应该由同一个 class 中声明的成员使用。不过

PHP 并不支持强制性的私有命名空间）应该用一个下划线开头。示例：

_sort()
_initTree()
$this->_status

常数

常数应该总是全部使用大写字母命名，用下划线来分隔单词。常数名字的前缀应该使用大写的 class/包

名字。例如：DB:: 包使用的所有常数都已 DB_ 开头。

全局变量

如果你的包需要定义全局变量，那么应该用下划线跟上包的名字和另一个下划线作为开头。例如，PEAR

包使用一个全局变量名为 $_PEAR_destructor_object_list。

预定义的值 true、false 和 null

PHP 的内建值 true、false 和 null 必须全部用小写字母书写。

内容总结

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

内容备注

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

内容手机端

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

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

来源：【匿名】

【上一篇】[php]phpfgetcsvwindows&&linux下兼容问题【下一篇】PHP 5 数据对象 (PDO) 抽象层与 Oracle

更多 ►

【[转自php中国]PHP编码规范】教程文章相关的互联网学习教程文章

PHP编码规范

1.文件格式所有php文件使用完整的php标签，如<?php ？>纯php代码文件，末尾不需要写 ?>2.文件和目录命名程序文件名和目录名均采用有意义的英文命名类统一采用：DemoTest.class.php接口统一采用：DemoTest.interface.php其他按照各自的方式：demoTest.{style}.php其他一些文件按照：demoTest.inc.php zend/demo.lib.php3.文件目录结构app　　独立的应用class 单个的类文件，...

php设计模式一之命名空间、自动加载类、PSR-0编码规范

本篇文章介绍的内容是php设计模式一之命名空间、自动加载类、PSR-0编码规范，现在分享给大家，有需要的朋友可以参考一下一、命名空间：解决在生产环境中多人协同开发时出现类名或函数名冲突的问题；test1.php<?php namespace Test1; function test(){echo "Test1命名空间下的test()方法"; } ?>test2.php<?php namespace Test2; function test(){echo "Test2命名空间下的test()方法"; } ?>test.php<?php require_once(test1.php); ...

PHP编码规范之注释和文件结构说明

php编码规范有哪些？【图】

为什么需要编码规范？为了提高工作效率，保证开发的有效性和合理性。为了提高代码可读性和可重复利用性，从而节约沟通成本。php编码规范1、文件格式　●　所有php文件使用完整的php标签，如<?php ？>　●　纯php代码文件，末尾不需要写 ?>2、文件和目录命名　●　程序文件名和目录名均采用有意义的英文命名　●　类统一采用：DemoTest.class.php　●　接口统一采用：DemoTest.interface.php　●　其他按照各自的方式：demoTest.{st...

http://67.220.92.14/forum/inde讲的非常不错的PHP编码规范第1/3页

注：这是从PHPCMS开发文档里看到编码规范，虽名为PHPCMS的开发规范，但我觉得所有的PHP编程都该如此。写了那么多PHP，很多编码对照这规范都感觉欠缺很多，今后一定要对照纠正。 Phpcms 编码规范 1. 引言…. 2 2. 适用范围…. 2 3. 标准化的重要性和好处…. 3 4. PHP编码规范与原则…. 3 4.1. 代码标记… 3 4.2. 注释… 3 4.3. 书写规则… 4 4.3.1. 缩进… 4 4.3.2. 大括号{}、if和switch. 4 4.3.3. 运算符、小括号、空格、关键词和...

PHP的编码规范

本篇文章给大家分享了关于PHP的编码规，很实用，有需要的朋友可以用来参考一下文件名：类：DemoTest.class.php接口：DemoTest.interface.php其他：demoTest.{style}.php命名规范：整体采用驼峰命名法，同时命名要有意义。全局变量：两边使用"_"，中间采用驼峰命名法常量：全大写普通变量/类属性：驼峰命名法，可以在前面加上表示变量类型的缩写,要采用准确有意义的英文单词：字符串： $sMyName数组： $arrMyArray接口及类的命名：驼...

新手PHP编码规范及建议

想要当一名出色的程序员，一手好的代码规范是很重要的，那么如何才能写出一手好代码呢？本文我们就给大家一些PHP 编码规范及建议。编码规范PHP代码文件必须以 <?php 标签开始。<?php //开头// 不结尾 PHP代码文件必须以不带BOM的UTF-8编码。例sublime, setting增加，"show_encoding" : true 每行的字符数不超过 80 个字符例，sublime "word_wrap": "true", "wrap_width": 80, tap键4个空格例，sublime "tab_size": 4, PHP代码中应该...

php关于编码规范的文档（收藏）

为了提高工作效率，保证开发的有效性和合理性，并最大程度提高程序代码的可读性和可重复利用性，提高沟通效率，需要一份代码编写规范。让大家养成良好的代码编写习惯，同时减少代码中的bug。 CleverCode整理了一些规范。本规范包含PHP开发时程序编码中命名规范、代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、常最命名等方面的规则。1 文件格式1.1 文件标记所有PHP文件，其代码标记均使用完整PHP标签...

PHP推荐标准PSRphp程序编码规范标准php标准差php网络编程标准教

PSR是PHP Standards Recommendation的简称。PSR-1：基本的代码风格PHP标签必须把PHP代码放在或标签中。不得使用其他PHP标签语法。编码所有PHP文件都必须使用UTF-8字符集编码，而且不能有字节顺序标记目的一个PHP文件可以定义符号（类、性状、函数和常量等），或者执行有副作用的操作（例如生成结果或处理数据），但不能同时做这两件事。自动加载PHP命名空间和类必须遵守PSR-4自动加载器标准。类的名称PHP类的名称必须一直使...

PHP编码规范-phpcodingstandard_PHP教程【代码】

目录介绍标准化的重要性解释认同观点项目的四个阶段命名规则合适的命名缩写词不要全部使用大写字母类命名类库命名方法命名类属性命名方法中参数命名变量命名引用变量和函数返回引用全局变量定义命名 / 全局常量静态变量函数命名 php文件扩展名文档规则评价注释 Comments Should Tell a Story Document Decisions 使用标头说明 Make Gotchas Explicit Interface and Implementation Do...

讲的非常不错的PHP编码规范第1/3页_PHP教程

PHP编码规范之注释和文件结构说明_PHP教程

PHP编码规范的深入探讨_PHP教程

缩进与空白字符（Indenting and Whitespace）使用 2 个空格而不使用 tab 键进行代码缩进（notepad++, Eclipse 等编辑器均支持此项配置）;行尾不应该有空白字符应使用 \n （Unix换行符），而不是 \r\n （Windows 换行符）所有文件均应以一个空行结尾运算符（Operators）所有二元运算符（二个值之间的运算符），如 +, -, =, !=, ==, > 等等，在运算符两端均需留有一个空格，如应该使用 $foo = $bar 而不是 $foo=$bar。所有一元运算符...

php编码规范个人小结_PHP教程

1.原生态代码或者类的头上，注明作者，关键算法计算过程例如 /** *@author zengmoumou *功能：根据列表ip，取得ip对应的运营商，省，市，县 */ 2.变量尽量用英文单词的组合，第一个小写，后面大写例如： $confTreeModel = D("ConfTree"); 3.函数名尽量用英文单词的组合，第一个小写，后面大写例如： function searchRealServer($keyword) 4.函数之上最好写名该函数的作者，变量，算法例如:/*** @author zengmoumou* 获得搜索到...

关于PHP开发编码规范_PHP教程

这是一个之前的一篇文章，感觉很好重新整理又发出来。希望能让大家有所收获。1. 介绍 1.1. 标准化的重要** 标准化问题在某些方面上让每个人头痛，让人人都觉得大家处于同样的境地。这有助于让这些建议在许多的项目中不断演进，许多公司花费了许多星期逐子字逐句的进行争论。标准化不是特殊的个人风格，它对本地改良是完全开放的。 1.2. 优点当一个项目尝试着遵守公用的标准时，会有以下好处：程序员可以了解任何代码，弄清程...

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中国]PHP编码规范

内容导读

内容图文

内容总结

内容备注

内容手机端

【[转自php中国]PHP编码规范】教程文章相关的互联网学习教程文章

PHP编码规范

php设计模式一之命名空间、自动加载类、PSR-0编码规范

PHP编码规范之注释和文件结构说明

php编码规范有哪些？【图】

http://67.220.92.14/forum/inde讲的非常不错的PHP编码规范第1/3页

PHP的编码规范

新手PHP编码规范及建议

php关于编码规范的文档（收藏）

PHP推荐标准PSRphp程序编码规范标准php标准差php网络编程标准教

PHP编码规范-phpcodingstandard_PHP教程【代码】

讲的非常不错的PHP编码规范第1/3页_PHP教程

PHP编码规范之注释和文件结构说明_PHP教程

PHP编码规范的深入探讨_PHP教程

php编码规范个人小结_PHP教程

关于PHP开发编码规范_PHP教程

PHP - 相关标签

PHP - 技术教程分类

PHP - 最新教程

PHP - 最热教程