腾讯php开发规范

《腾讯php开发规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、OMG网络媒体技术部海豹平台开发规范v1.0海豹平台开发规范v1.0腾讯科技（深圳）有限公司*版本信息&保密等级版本更改日期更改要点说明编制审核批准V1.02013/12/24新建wilsonwsongOMG网络媒体技术部海豹平台开发规范v1.0V1.12013/12/26修订rusherding文档保密等级：□机密■内部□公开OMG网络媒体技术部海豹平台开发规范v1.0目录海豹平台开发规范V1.011引言51.1定义及缩略语51.2参考文档51.3目的51.4适用范围51.5标准化作用52目录结构规范62.1框架路径62.2应用目录结构6

2、2.2.1配置config72.2.2控制器controllers72.2.3模型models72.2.4视图views82.2.5国际化messages82.2.6组件components82.2.7命令commands82.2.8临时目录runtime82.3路径别名82.3.1类型导入83PHP编码规范93.1标签93.2编码93.3注释93.3.1文件注释93.3.2类注释103.3.3方法注释103.3.4属性注释113.3.5其它113.4命名规则113.4.1文件113.4.2类12OMG网络媒体技术部海豹平台开发规范v1.0

3、3.4.3函数/方法123.4.4变量名123.4.5常量名123.5书写规则133.5.1文件133.5.2行133.5.3缩进133.5.4控制结构133.5.5运算符163.5.6引号163.5.7关键词173.5.8函数173.5.9类173.5.10属性183.5.11方法184数据库命名规范204.1命名规范204.2实体命名204.2.1前缀命名204.2.2后缀命名214.3字段命名214.3.1后缀命名224.4字段类型224.4.1数值类型224.4.2字符类型234.4.3时间类型234.4.4ENUM&SET234.

4、4.5LOB类型234.5表结构设计244.5.1适度冗余244.5.2尽量使用NOTNULL244.5.3索引245附件245.1附录一：MYSQL保留字24OMG网络媒体技术部海豹平台开发规范v1.01引言1.1定义及缩略语缩略词说明海豹平台运维中心提供的研发平台，提供框架、公共基础组件、公共业务组件加速业务的日常研发工作1.2参考文档海豹平台WIKI：http://wiki.seals.webdev.com/1.3目的本规范由编程原则组成，融合并提炼了开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格。以达到事半功倍的效

5、果，如果有需要本文档会不定期更新。1.4适用范围如无特殊说明，以下规则要求完全适用于基于海豹平台框架开发的应用，同时也可大部分适用于部门其他PHP项目。1.5标准化作用OMG网络媒体技术部海豹平台开发规范v1.0当一个软件项目尝试着遵守公共一致的标准时，可以使参与项目的开发人员更容易了解项目中的代码、弄清程序的状况。使新的参与者可以很快的适应环境，防止部分参与者出于节省时间的需要，自创一套风格并养成终生的习惯，导致其它人在阅读时浪费过多的时间和精力。而且在一致的环境下，也可以减少编码出错的机会。缺陷是由于每个人的标准不同，所以需要一段时间来

6、适应和改变自己的编码风格，暂时性的降底了工作效率。从使项目长远健康的发展以及后期更高的团队工作效率来考虑暂时的工作效率降低是值得的，也是必须要经过的一个过程。标准不是项目成功的关键，但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。1)程序员可以了解任何代码，弄清程序的状况2)新人可以很快的适应环境3)防止新接触PHP的开发出于节省时间的需要，自创一套风格并养成终生的习惯4)防止新接触PHP的开发一次次的犯同样的错误5)在一致的环境下，可以减少犯错的机会1目录结构规范1.1框架路径框架引用路径必须采用绝对路径，托管的开发、

7、测试和正式环境必须为：/data/php/framework1.2应用目录结构应用需要严格参考以下目录安排代码位置：webroot/index.phpWeb应用入口脚本文件index-test.php功能测试使用的入口脚本文件assets/包含公开的资源文件css/包含CSS文件images/包含图片文件themes/包含应用主题protected/包含受保护的应用文件OMG网络媒体技术部海豹平台开发规范v1.0modc命令行脚本modc.batWindows下的命令行脚本modc.php命令行PHP脚本commands/包含自定义的'mo

8、dc'命令components/包含可重用的用户组件config/包含配置文件controllers/包含控制器的类文件SiteController.php默认控制器的类文件ex