PHP编码规范

命名====================================

类命名
名字的首字母使用大写
各单词首字母使用大写,其他的字母均使用小写
不要使用下划线 _ 例如:
class NameOneTwo
class Name

方法命名
名字首字母小写,使用单词首字母大写或 下划线 _ 链接各单词,下划线 _ 后单词首字母小写
class NameOneTwo {
function doIt_note(){};
function handleError(){};
}

类属性命名
属性命名应该以字符 m 为前缀。
前缀 m 后采用于类命名一致的规则。
前缀‘m‘防止类属性和方法名发生任何冲突。方法名和属性名经常会很类似,特别是存取元素。
例如
class NameOneTwo {
var mErrorNumber;
var mrName;
function varAbc(){};
}

类静态变量
静态变量应该带前缀 s
例如
class NameOneTwo {
static $msStatus = 0;
}

变量命名
规则同方法命名
全局常量
全局常量所有字母应该大写,并以 _ 作为分界
例如
define("A_GLOBAL_CONSTANT", "Hello world!");

文件夹文件名
文件夹命名一般采用英文,长度一般不超过15个字符,命名采用小写字母。一些常见的文件夹命名如:images或img(存放图形文件),flash(存放Flash文件),style或css(存放CSS文件),scripts或js(存放Javascript脚本),media(存放多媒体文件)等。
文件名称统一用小写的英文字母、数字和下划线的组合。

注释====================================

注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害
程序块的注释常采用 /*…*/ ,行注释一般采用 //…
所有的PHP代码源文件都应该在开头有一个C语言风格的注释,其中列出类名、功能、版本信息、日期、作者

/*
* 功能
* 日期
* 作者
* 版本
* 版权
*/

例如
/**
* 代理管理中心模块
*@date 2015.5.22
* @author 张某某
* @since v2.0
* @copyright Copyright (c) 2013-2015 某某科技
*/

方法注释例如
/**
*用户中心右边,小导航(作用)
*
* @param string $menu_type 导航类型
* @param string $menu_key 当前导航的menu_key
* @param array $array 附加菜单
* @return array $arrUser
*/

如果时间紧迫至少写明方法作用,例如
/**
* cms专题编辑
*/

如果对文件进行了修改,应该在对应代码前面说明修改目的、修改日期、修改人,并且标识出修改部分的起止位置
……

/*
 * 修改目的
 * 修改日期
 * 修改人
 * 版本
 */

……

//修改人修改起始

……

……

//修改人修改结束

……

变量初始化====================================

尽量声明局部变量的同时初始化。唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算。

布局====================================

方法与方法之间以空行分隔

统一一个制表(TAB)符作为缩进排版的一个单位。

操作符与变量之间用空格分隔

多个参数列表中(方法,或数组里),参数逗号的后面应该有空格

位于for循环中作为计数器值的数字常量,除了-1,0和1之外,不应被直接写入代码。
大括号{}使用
for, if, while, do, switch 等关键词后面的 { 要与关键字同行
例如
if(true){
......
}

{ }之内的代码块在 { 下边缩进一个Tab处左对齐。不允许用空格代替Tab
编辑器内自动格式化缩进设置成Tab

声明块的定位
只在代码块的开始处声明变量。(一个块是指任何被包含在大括号"{"和"}"中间的代码。)不要在首次用到该变量时才声明。
多变量根据系统执行调用顺序依次“归类”声明。同时为多个变量赋值时,同类别后面的等号用空格控制对齐
例如

function myMethod(){
// 方法块的开始
$name = $_GET[‘name‘];
$age = $_GET[‘age‘];
$sex = $_GET[‘ sex ‘];

$model1 = Model();
$model2 = Model();

$int1 = 0;
$int2 = 0;

if ($condition){
int $int2 = 0; // "if"块的开始
...
}
}

PHP代码块用<?php ?>来标记。禁止用<? ?>或<?= ?>

小括号、关键词和函数空格规则
关键字之后要留空格,否则无法辨析关键字。不要把小括号和if、for、while等关键词紧贴在一起,要用空格隔开它们,以突出关键字
方法名后面的小括号要紧贴方法名,不要留有空格

if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加 {} 。这样可以防止书写失误

switch 格式,所有 case 对齐在switch下的一个缩进,所有case对应的执行语句在case下的一个缩进
如果一个case分支执行完后继续进入下一个case执行,那么必须写注释

行长度
尽量避免一行的长度超过80个字符,因为很多终端和工具不能很好处理之。
换行
当一个表达式无法容纳在一行内时,可以依据如下一般规则断开之:

- 在一个逗号后面断开
- 在一个操作符前面断开
- 新的一行应该与上一行同一级别表达式的开头处对齐
- 如果以上规则导致代码混乱或者使代码都堆挤在右边,那就代之以缩进一个制表符

时间: 2024-10-13 11:36:23

PHP编码规范的相关文章

java编码规范

右括号") "与其后面的关键字之间,关键字与其后面的左括号"("或"{"之间,以及"}"与"{"之间,要以一个空格隔开:除". "外,所有二元操作符的前.后要加空格:在逗号后边加一个空格. 说明: 一个紧跟着括号的关键词应该被空格分开: 空白应该位于参数列表中逗号的后面: 所有的二元运算符,除了".",应该使用空格将之与操作数分开.一元操作符和操作数之间不应该加空格,

我也学php:编码规范/翻译自PSR

PHP社区百花齐放,拥有大量的函数库.框架和组件.PHP开发者通常会在自己的项目中使用若干个外部库,因而PHP代码遵循或尽量接近同一个代码风格就非常重要,可以让开发者方便地把多个代码库集成在自己的项目中. 框架互操作组(即PHP标准组)发布了一系列代码风格推荐标准,即PSR-0,PSR-1,PSR-2和PSR-3. 不要让这些名称所混淆,这些推荐仅是一些被其它项目所遵循的规则,如Drupal, Zend, Symfony, CakePHP, phpBB, AWS SDK, FuelPHP, Li

阿里Java编码规范

详细,全面 很不错 阿里 Java编码规范

html编码规范

不久前接到老大下达的任务,要拟定一份公司前端编码规范的草稿,参考了各大公司的编码规范,结合现在公司的特点,整理出以下编码规范: html规范 1 文件相关 (1) 文件名以英文为主,可以使用下划线(如active.html),压缩包以项目名+日期的形式. (2) 统一使用utf-8编码. (3) css.js发布到线上都需要压缩. (4) 在追求高度优化的站点,需要对图片也进行无损压缩. 2 代码风格 2.1 命名 (1) 元素 id 必须保证页面唯一.(解释:同一个页面中,不同的元素包含相同的

【转】Airbnb React编码规范

Airbnb的编码规范是在业界非常流行的一套规范,而且它一直都在进化,推出最新技术的规范 原文:https://zhuanlan.zhihu.com/p/20616464 用更合理的方式书写React和JSX 基本规则 每个文件只包含一个React组件: 但是无状态, 或者 Pure 组件 允许一个文件包含多个组件.eslint: react/no-multi-comp. 始终使用 JSX 语法; 不要使用 React.createElement方法,除非初始化 app 的文件不是 JSX 格式

Bootstrap编码规范

黄金定律 永远遵循同一套编码规范 -- 可以是这里列出的,也可以是你自己总结的.如果你发现本规范中有任何错误,敬请指正.通过 open an issue on GitHub为本规范添加或贡献内容. 不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的. HTML 语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法. 嵌套元素应当缩进一次(即两个空格). 对于属性的定义,确保全部使用双引号,绝不要使用单引号. 不要在自闭合(self-clo

iOS:Cocoa编码规范 -[译]Coding Guidelines for Cocoa

--原文地址:https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/FrameworkImpl.html Cocoa编码规范 --前言 用公共API开发一个Cocoa框架,插件,或其他可执行目标,里面的命名编写和规范不同于一般应用程序的开发.因为你开发出来东西是给开发者用的看的,并且他们不熟悉你的编程接口.这个时候API的命名约定就派上用场了,因为它使你的写

说说Python编码规范

前言 已有近两个月没有发表过文章了,前段时间外甥和女儿过来这边渡暑假,平常晚上和周末时间都陪着她们了,趁这个周末有空,再抽空再把这块拾起来.         这么久没写了,再次拿起键盘,想想,发表些什么呢,想起上次公司的代码评审委员会下周其中一个议题是关于Python编码规范的整理,那就趁热打铁,整理一份关于Python编码规范的文章,也为那些写Python的人,提供一些编码注意的一些事项或者说是参考吧. 编码规范的作用         规范故明思义,就是通过不断的总结,吸取好的点,从而形成的一

Android 编码规范

编码规范对于程序员而言,尤为重要,有以下几个原因: 一个软件的生命周期中,80%的花费在于维护: 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发来维护: 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码: 如果你将源码作为产品发布,就需要确认它是否被很好的打包并且清晰无误,一如你已构建的其他任何产品: 命名 1.包命名 包名规则:一个唯一的包名的前缀总是全部小写的ASCII字母并且是一个顶级域名,如com.edu.gov.net.org等.包名的后续部分根据不同机构各

PSR : php编码规范

诸王混战 关于开发标准这块,可以说一直都是风格迥异,各家都有各家的玩法,民间更是个人玩个人的.目前我们国内比较出名的几个框架(Yii,Laravel) 都已经支持Composer并且加入了PHP-FIG(php框架程序组). 其中Composer的自动加载就支持PHP-FIG指定的PSR-0 和 PSR-4 规范来实现自动加载机制,并且Composer推荐使用PSR-4 PHP-FIG 这是一个自愿非正式的机构,但是就目前对我们的影响来看,可能都已经默认为一个公信组织了,的的确确制定了不少非常好