开发规范系列-php篇.pdfVIP

杭州批城贸易开发规范系列 Php 开发规范 版本号 创建者 创建时间 修改者 修改时间 备注 苏骞 2011-5-31 苏骞 2011-5-31 创建文档 一、规范说明 随着公司的发展，项目数量、项目规模及项目人员都发展起来了。但是相应的规范并没 有建立起来，每个项目人员都遵守自己的一套规则，没有统一的机制和流程去遵守，导 致项目越来越臃肿，维护成本越来越大，开发越来越难。影响公司后期和长远的规划与 发展。无规矩，不成方圆。我们是一个集体，是一个团队，在遵守开发人员的独立性的 同时，我们应当有相应的统一性的硬性规定，对于我们开发团队来说，即规范。 二、开发理念 简单、快速、敏捷 三、开发原则 A 、安全第一、性能优先 B 、 可用性、可维护性、可扩展性 C、责任、使命、结果 四、开发工具 开发人员的开发工具尽量统一，这样可以统一部署、统一维护。可以保持代码风格的统 一性。程序易维护、易阅读. 编程工具：zend studio (便于重构、效率高、功能多、统一部署);辅助工具Ediplus 五、命名规范 命名是以不以数字开头的，采取得26 个英文字母、10 个数字和下划线组成的，命名应 简单，通俗易懂。方便开方人员之间的交流及维护。 原则：观其名，知其义。 A 、变量命名:采取驼峰式法则,通过变量名我们应知道变量的范围，变量要做的事，变 量的类型。 1、全局变量：$gUserId,g 是global 的缩写,g 后面紧跟着驼峰式的变量名,不过变量 名首字母大写,缩写为小写。 2 、静态变量：$sBusRouter,s 是static 的缩写,s 后面紧跟着驼峰式的变量名,不过变 量名首字母大写,缩写为小写。 3、局部变量：$lThreadId,l 是local 的缩写,l 后面紧跟着驼峰式的变量名,不过变量 名首字母大写,缩写为小写。 4 、配置变量：配置变量是来自于配置文件中的变量，可能有其特殊性。以配置名 开头，连接下划线, 后面紧跟着驼峰式的变量名,$db_config 。 1 5、普通变量：$appInfo 驼峰式的变量名。 6、参数变量：是指函数参数的变量，function(array $A, Exception $e, $iAge);如果参 数可以用类型表示，尽量用类型表示，如变量$A 是数组，如果不能用类型表示 的尽显用类型间写+参数名。如$iAge 表示是整型的，i 是整型缩写。 Int-i,float-f,double-d,string-str,Boolean-b 7、常量定义：常量名全部用大写，用下划线连接，简单易懂。比较难记难懂的值、 全局通用但不更改的的值尽量用常量。 1 表示用户审核状态,通过WHOLESALE_USER_STATUS_CHECK 简单易懂 define(WHOLESALE_USER_STATUS_CHECK, 1); B 、函数命名：采取驼峰式法则，尽量能够表达函数要做的事情，尽量使用动宾结构 1、 全局函数:gGetUserInfoByUid();g 是global 的缩写,g 后面紧跟着驼峰式的 变量名,不过变量名首字母大写。从函数名的信息可以知道，我们是通过 用户ID 取得用户信息。但全局函数有专门文件处理 2 、 局部函数:checkUsername();驼峰式法则 C、类的命名：采取驼峰式法则，尽量能够表类的职责，是提供服务，接口，还是封装 等。