没有合适的资源?快使用搜索试试~ 我知道了~
PHP程序编码标准规范.doc
需积分: 9 10 下载量 82 浏览量
2011-08-07
11:17:48
上传
评论
收藏 140KB DOC 举报
温馨提示
试读
15页
为了更好的提高开发的工作效率,保证开发的有效性和合理性,并最大程度的提高代码的可读性和可重复利用性,制订此规范。本规范包含了PHP开发时程序编码中代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、文件头的注释块、CVS标记、URL样例、常量命名等方面的规则。
资源推荐
资源详情
资源评论
PHP 程序编码标准规范
1.绪论
为了更好的提高开发的工作效率,保证开发的有效性和合理性,并最大程度的提高代码的可读性和可重
复利用性,制订此规范。本规范包含了 开发时程序编码中代码缩进规则、控制结构、函数调用、函数定
义、注释、包含代码、 标记、文件头的注释块、 标记、 样例、常量命名等方面的规则。
1.1 优点
当一个项目尝试着遵守公用的标准时,会有以下好处:
程序员可以了解任何代码,弄清程序的状况
新人可以很快的适应环境
防止新接触 的人出于节省时间的需要,自创一套风格并养成终生的习惯
防止新接触 的人一次次的犯同样的错误
在一致的环境下,人们可以减少犯错的机会
程序员们有了一致的敌人
1.2 改进
规范并不是一成不变的,如果你觉得规范缺少东西或者有些不合适的地方,提出来,也许
项目管理者会考虑加入,记住,任何项目都取决于团队合作的努力。
1.3 实施
一般情况下,规范的实施是由技术负责人或者项目经理执行和监督的。但是最好的方法还
是在开发团队中达成共识,变成一种文化的存在。
1.4 目标
编码标准对任何开发项目都很重要,特别是很多开发者在同一项目上工作。编码标准帮助
确保代码的高质量、少 和容易维护、新人接手快。
2.PHP File 文件格式
2.1. 常规
对于只包含有 代码的文件,结束标志()是不允许存在的, 自身不需要(
)这样做可以防止它的末尾的被意外地注入相应。
重要:
由 允许的任意的二进制代码的内容被 !"#$%&"'
中的 文件或由它们产生的文件禁止。 这个功能的使用只对一些安装脚本开放。
2.2. 缩进
缩进由四个空格组成,禁止使用制表符 (。
2.3. 行的最大长度
一行 )*字符以内是比较合适,就是说,!的开发者应当努力在可能的情况下保持每行代
码少于 )*个字符,在有些情况下,长点也可以但最多为 +,*个字符。
2.4. 行结束标志
行结束标志遵循 -.文本文件的约定,行必需以单个换行符(!)结束。换行符在文件
中表示为 +*,或 +/ 进制的 *.*。
注:不要使用 苹果操作系统的回车(*.*0)或 1- &%2电脑的回车换行组合如
(*.*0*.*)。
3. 命名约定
3.1. 类
建立包含类库目录(类似 Java 包管理,zend),以不通的目录代表不同的命名空间。
使用大写字母作为词的分隔,其他的字母均使用小写
名字的首字母使用大写 ,如果类名包含多个单词,每个单词的第一个字母必须大写,连续的
大写是不允许的,不要以 或 3开头。
下划线44,下划线只允许做路径分隔符;
不能以数字开头,空格及特殊字符不能出现。
例如
56#227#$%&
56#227#$8
6#22.&"9 :
注意:
在为类(56#22)命名前首先要知道它是什么。如果看到类名,你还是想不起这个类是什
么的话,那么你的设计就还做的不够好。
超过三个词组成的混合名是容易造成系统各个实体间的混淆,再看看你的设计,尝试使用
(22-&5#" 看看该命名所对应的实体是否有着那么多的功用。
对于派生类的命名应该避免带其父类名产生关系,一个类的名字只与它自身有关,和它的父类
叫什么无关。
有些后缀名是几乎是约定俗成的,例如:如果你的系统使用了代理(#9),那么就把某
个部件命名为“下载代理”(0&%6&# 9)用以真正的传送信息。
缩写词不要全部使用大写字母使用;<99$69#9-29-5=不使用;<99#9-29-5=
Zend Framework 的类命名总是对应于其所属文件的目录结构的,ZF 标准库的根目录是 “Zend/>,ZF 特别
(extras)库的根目录是 "ZendX/",所有 Zend Framework 的类在其下按等级存放。
类名只允许有字母数字字符,在大部分情况下不鼓励使用数字。下划线只允许做路径分隔
符;例如 ?0?#6=文件里对应的类名称是 0#6。
如果类名包含多个单词,每个单词的第一个字母必须大写,连续的大写是不允许的,例如
“ 0!>是不允许的,而 :是可接受的。
这些约定为 !"#$%&"'定义了一个伪命名空间机制。如果对开发者在他们的程序
中切实可行, !"#$%&"'将采用 命名空间特性(如果有的话)。
参见在标准和特别库中类名作为类名约定的例子。
重要:
依靠 !库展开的代码,但又不
是标准或特别库的一部分(例如程序代码或不是 发行的库),不要以 或
3开头。
3.2. 文件名
例如:7%2-29=8
文件命名上有些几乎是约定俗成的单词,比如 # $- 前缀表示是后台管理的文件
名-5= 后缀则表示包含文件或者类库文件,56#22= 后缀表示类库文件等等。
5&@= 表示配置文件等。
例如: $-2"=80#9#=-5=2"=56#22=
对于其它文件,只有字母数字字符、下划线和短横线(A)可用,空格是绝对不允许的。
包含任何 代码的任何文件应当以 =扩展名结尾,众所周知的视图脚本除外。下
面这些例子给出 !"#$%&"'类可接受的文件名:
?0
?&9"&66"?!"&9=
?-%?6"?!&"$# -&=
文件名必须遵循上述的对应类名的规则。
3.3. 函数和方法
函数名只包含字母数字字符,下划线是不允许的。数字是允许的但大多数情况下不鼓励。
函数名总是以小写开头,当函数名包含多个单词,每个子的首字母必须大写,这就是所谓
的 “驼峰” 格式。
我们一般鼓励使用冗长的名字,函数名应当长到足以说明函数的意图和行为。
这些是可接受的函数名的例子:
@69"9
96$9(B
%- 9!#59&"B
后缀名;
#.A含义为某实体所能赋予的最大值。
9A一个运行中的计数变量的当前值。
CBA键值。
前缀名:
-2A含义为问一个关于某样事物的问题。
9A含义为取得一个数值。
29A含义为设定一个数值
对于面向对象编程,实例或静态变量的访问器总是以 9或 29为前缀。在设计模式
实现方面,如单态模式(2-69&)或工厂模式(:#59&"B), 方法的名字应当包含模式的名
字,这样名字更能描述整个行为。
在对象中的方法,声明为 "-D#9或 "&959 的, 名称的首字符必须是一个单个的
下划线,这是唯一的下划线在方法名字中的用法。声明为 6-5的从不包含下划线。
全局函数 如:E	-:59-&2允许但大多数情况下不鼓励,建议把这类函数封装
到静态类里。
3.4. 变量
变量只包含数字字母字符,大多数情况下不鼓励使用数字,下划线不接受。
声明为 "-D#9或 "&959 的实例变量名必须以一个单个下划线开头,这是唯一的
下划线在程序中的用法,声明为 6-5的不应当以下划线开头。
对函数名(见上面 F=F节)一样,变量名总以小写字母开头并遵循“驼峰式”命名约定。
我们一般鼓励使用冗长的名字,这样容易理解代码,开发者知道把数据存到哪里。除非在
小循环里,不鼓励使用简洁的名字如 G-和 G。如果一个循环超过 ,*行代码,索引的变
量名必须有个具有描述意义的名字。
3.5. 常量
常量包含数字字母字符和下划线,数字允许作为常量名。
常量名的所有字母必须大写。
常量中的单词必须以下划线分隔,例如可以这样
(0(037但不许这样
(0(037。
常量必须通过 5&29定义为类的成员,不鼓励使用 @定义的全局常量。
4. 编码风格
剩余14页未读,继续阅读
资源评论
zhouguoqing917
- 粉丝: 2
- 资源: 16
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功