腾讯PHP开发规范.doc

腾讯科技(深圳)有限公司
*版本信息&保密等级
版本
更改日期
更改要点说明
编制
审核
批准

2013/12/24
新建
wilsonwsong

2013/12/26
修订
rusherding
文档保密等级:
□机密■内部□公开
目录
1
1 引言 5
定义及缩略语 5
参考文档 5
目的 5
适用范围 5
标准化作用 5
2 目录结构规范 6
框架路径 6
应用目录结构 6
配置config 7
控制器controllers 7
模型models 7
视图views 8
国际化messages 8
ponents 8
mands 8
临时目录runtime 8
路径别名 8
类型导入 8
3 PHP编码规范 9
标签 9
编码 9
注释 9
文件注释 9
类注释 10
方法注释 10
属性注释 11
其它 11
命名规则 11
文件 11
类 12
函数/方法 12
变量名 12
常量名 12
书写规则 13
文件 13
行 13
缩进 13
控制结构 13
运算符 16
引号 16
关键词 17
函数 17
类 17
属性 18
方法 18
4 数据库命名规范 20
命名规范 20
实体命名 20
前缀命名 20
后缀命名 21
字段命名 21
后缀命名 22
字段类型 22
数值类型 22
字符类型 23
时间类型 23
ENUM&SET 23
LOB 类型 23
表结构设计 24
适度冗余 24
尽量使用NOT NULL 24
索引 24
5 附件 24
附录一:MYSQL保留字 24
引言
定义及缩略语
缩略词
说明
海豹平台
运维中心提供的研发平台,提供框架、公共基础组件、公共业务组件加速业务的日常研发工作
参考文档
海豹平台WIKI:./
目的
本规范由编程原则组成,融合并提炼了开发人员长时间积累下来的成熟经验,意在帮助形成良好一致的编程风格。以达到事半功倍的效果,如果有需要本文档会不定期更新。
适用范围
如无特殊说明,以下规则要求完全适用于基于海豹平台框架开发的应用,同时也可大部分适用于部门其他PHP项目。
标准化作用
当一个软件项目尝试着遵守公共一致的标准时,可以使参与项目的开发人员更容易了解项目中的代码、弄清程序的状况。使新的参与者可以很快的适应环境,防止部分参与者出于节省时间的需要,自创一套风格并养成终生的习惯,导致其它人在阅读时浪费过多的时间和精力。而且在一致的环境下,也可以减少编码出错的机会。
缺陷是由于每个人的标准不同,所以需要一段时间来适应和改变自己的编码风格,暂时性的降底了工作效率。从使项目长远健康的发展以及后期更高的团队工作效率来考虑暂时的工作效率降低是值得的,也是必须要经过的一个过程。标准不是项目成功的关键,但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。
程序员可以了解任何代码,弄清程序的状况
新人可以很快的适应环境
防止新接触PHP的开发出于节省时间的需要,自创一套风格并养成终生的习惯
防止新接触PHP的开发一次次的犯同样的错误
在一致的环境下,可以减少犯错的机会
目录结构规范
框架路径
框架引用路径必须采用绝对路径,托管的开发、测试和正式环境必须为:
/data/php/framework
应用目录结构
应用需要严格参考以下目录安排代码位置:
webroot/
Web 应用入口脚本文件
index- 功能测试使用的入口脚本文件
assets/ 包含公开的资源文件
css/ 包含 CSS 文件
images/ 包含图片文件
themes/ 包含应