交大铭泰内部 PHP 编码规范
SUNV’S PHP-CODING CRITERION
WITHIN
USING
交大铭泰内部 PHP 编码规范
目录: 第一部分: 1. 文件结构 2. 命名规则 3. 变量声明与使用 4. 语句的结构 5. 函数与类 6. 注释与
文档 7. 组件与第三方代码的使用 8. 影响系统的处理方式 第二部分 9. 设计层次与业务逻辑 10. 完善你的
设计 11. 高级应用 第三部分 12. 如何做好你的项目控制 第四部分 13. 规范的版本控制与修改
第一部分: 第一部分: 1. 文件结构 通常的一个站点的根目录都作为开发项目的根目录,开发环境,测试环境尽量与最终的运行 环境保持一致。文件目录的合理存放,能够为使的业务逻辑更清晰更有效。 下面所列举的一个例子代表着一个 SOA(面对服务体系)
系统的一般结构
2010-11-26 Created by sunv 研发中心
1
交大铭泰内部 PHP 编码规范 /root
SUNV’S PHP-CODING CRITERION
WITHIN
USING
---[common]――――――――――公共文件存放目录 ---/images―――――――――-公用图片 ---/js――――――――――――-JAVASCRIPT 脚本文件 ---/css――――――――――――CSS 文件 ---/media――――――――――-媒体文件和其他资料 ---/filelist.xml―――――――――文件目录 ---[app]―――――――――――――应用程序 ---/login―――――――――――
登陆服务 ---/logic1―――――――――――逻辑业务 1 ---/logic2―――――――――――逻辑业务 2 …… ---/filelist.xml―――――――――该部分文件列表 ---[include] ---/Smarty.Conf.php―――――典型模板配置文件 ---/ADODB.Conf.php―――――典型数据库配置文件 ---/templates――――――――模板文件 ---/adodb――――――――――数据库操作文件 ---/function―――――――――函数文件 ---/classlib――――――――― 类文件 ---/filelist.
xml――――――――该部分文件列表 ---[Config.ini.php]―――――― 全站配置文件 …… 站点的二级子目录下面应存放 filelist.xml 其中定义了文件的完整树型
列表,以便文件的查找与。 同时,在开发环境,到测试环境,到最终运行环境,目录的名称请始终保持小写,因为 Linux 境严格区分大小写,大写目录在 URL 转换过程中会出现访问不到的情况 最好在您开发的单独的服务项目中存放 README 文件,说明该部分的以下特征: 外部关联部分, 名称 作用
文档结构 注意事项 外部关联部分,内部关联部分 版本控制 修改说明 您的信息 如果您使用的是函数化 函数化设计: 函数化 请将您的函数存放于/include/function/下 如果您使用的是 OOP 的模式: 请将您的公用类存放于/include/classlib/下 请将你的私有类存放于您的业务或逻辑目录下,/app/lo
gicservice/保持与您的上层目录同名 如:/app/dictonline/dictonline.class.php
2. 命名规则 合理的命名,能够使事务易于被理解,能够很好的被别人理解,使一个编码人员直接通过
程序表 达出自己的思维与观念。 1. 文件命名 文件命名一般都采用小写字母,可以使英文表达意思也可以使拼音全拼,但长度最好不要超 过 20。 按照大家惯例所形成的英文缩写格式可以直接采用,但是自定义的英文单词的缩写应最少保
2010-11-26 Created by sunv 研发中心
2
交大铭泰内部 PHP 编码规范 持 4 个字母:
SUNV’S PHP-CODING CRITERION
WITHIN
USING
condition 一般可以写成 cond connect 一般可以写成 conn 文件命名应采用名+动格式表达文件的主要功能,属性或内容: filelist.php 指文件列表 projcetdetail.php 指明细项目
针对内部使用,没有用户界面,无输出显示或含有跳转的页面应在名称后面添加”_”: fileedit_.php 指文件编辑的处理文件 2. 变量命名 变量在 PHP 中是数据成员的基本组成单位 变量一般的都采用名次或者拼音全拼来表示其含