PHP程序编码规范[精校版本]

1、程序编码规范1、 基本的编码规范，与国际接轨，见附录The PHP Coding Standard (中文版 | 英文版) ；2、 新的程序/项目的服务器配置中，php.ini关闭error_reporting, register_globals, magic_gpc, session.auto_start，需要查看错误信息的在程序中设置，但正式上线的项目要保证及时关闭；3、 新的程序/项目都采用UTF-8编码，包括数据库、程序(无BOM)和页面(无BOM)等；4、 新的程序/项目都使用公司开发框架SimplePHP；5、 新的大中型程序/站点都要经过压力测试调整改进后上线；6、 使用统一的I

2、DE，保证团队的编码格式和一些细节的统一，目前公司统一使用ZendStudio/Zend Studio for Eclipse；7、 原则上不允许修改Simple框架核心代码，即SimplePHP目录下的所有文件，如有需要，请通知框架维护升级人员评估处理，Simple框架在下一步计划中将大幅度调整改进，以满足开发需求；8、 目录名只能使用英文字母加阿拉伯数字及下划线的组合字符串，而一些重要的并且用户能直接访问到的后台管理目录不能直接使用像admin，tool之类的常用单词来命名。9、 特定目录统一命名：模板目录views，语言包目录langs，配制目录config。目录名统一全小写命名。10、

3、 文件名（包括成生的静态页面，缓存等文件）尽量使用小写字母命名，必要时用下划线连接，但不能出现空格。框架控制器文件必须保证第一个字母为大写，其它均为小写，以保证大小写链接均可正常使用；11、 尽量使用公共的类库（公共的类库收集整理在进行中，并且将不断补充完善）；12、 站点/项目主程要负责编写、补充站点/项目文档（包括站点/项目说明，系统架构说明，目录/文件结构说明，接口说明，更新历史，手册文档）；开发文档统一存放在项目的根目录（不是WEB根目录）下doc目录的dev目录。而项目需求等非技术性的文档放在doc目录下的pro目录。数据库表文档规范：模块名称：(如用户表) 表名(如mmosite_

4、user)表的说明：系统用户表字段类型空默认注释键索引field1int(10)N自增主键Yfield2varchar(32)NN备注：对某些字段的补充必要的说明或者自己的设计思想；如果数据库后期有改动，文档上应随之改动，保持同步。13、 每个类库/程序文件都要按统一的格式写上说明和注释；文件和类库命名尽量都加上项目或者类库缩写作为前缀，当然如果升级到PHP5.3以后可以使用命名空间处理，文档注释：/* * 图片处理类(简述) * * 可实现剪裁、缩放、水印等功能 * 支持旋转，加文字等功能* (详细的功能描述，不够换行继续) * * copyright Copyright (c) 2005

5、- 2009 TM WebSoft Inc. () * author xxx * package Core * version $Id: image.php,v 1.0 2009.03.13 09:30:48 JJC Exp $ */方法或函数注释：/* * 取出指定名称的设置值 * * example: * * setAppInf(page_title, 标题); * . * $siteTitle = getAppInf(siteTitle); * * * param string $option * param mixed $default *

6、* return mixed */function getAppInf($option, $default = null) 一个较完整的注释格式见附件sample.php；14、 编写SQL语句时，最后要加上注释，#作者，修改者1，修改者2，以便查找原因和追踪责任到个人eg. SELECT * FROM table WHERE id = 1 #JJC15、 每个项目，框架的数据库表命名规范，一般以项目名_为前缀；如mmosite，整个垂直频道运用的$tablepre起成“mmosite_”的一层形式，而不是两层“mmosite_space_”，然后全站统一使用这个$tablepre，每个频道定义时使用$ tablepre space_user_info等；16、 数据库名、数据表名、字段名全部用小写，多个单词间用下划线_连接；查询语句SQL中，关键字一律用大写字母，字段名用定界符包含起来(如：字段名)；17、 保证安全可靠，必要的过滤和防护要做到位，如：SQL注入、XSS攻击、CC攻击等，密码等敏感数据不能明文放在Cookie中，特别是输入参数处理，生成的JS（供其它站点调用）过滤等，没用使用SimplePHP框架的项目统一使用目前公司的公用过滤代码；18、 保证程序稳定可靠，尽可能提高程序的质量，特别是大访问量的站点或程序，要预先做好处理，