PHP代码编写规范.pdfVIP

QC 质量管理体系文件 代码编写规范 受控状态： ■受控 □非受控 发布日期：2006 年02 月20 日 实施日期：2006 年02 月24 日 代码编写规范 代码编写规范 文件编号 1.0 版 共4页（含本页） 编 制 PHP开发组 审 核 批 准 编制日期 2006.02.24 审核日期 批准日期 实施日期 修改日期 文 件 会 签 表 部门名称 会签人/日期 主要责任部门 软件开发部 赵晨淋/2006-02-23 相关责任部门 文 件 修 改 记 录 修改单号 修改页码 修改人 批准人 生效日期 第 1 页 代码编写规范 1. 引言 1.1. 目的 制定本规范是为了能达到以下目的：  提高程序员工作效率和代码的利用性  程序员可以了解任何代码，弄清程序的状况  新人可以很快的适应环境  防止新接触php的人出于节省时间的需要，自创一套风格并养成终生的习惯  防止新接触php的人一次次的犯同样的错误  在一致的环境下，人们可以减少犯错的机会 1.2. 适用范围 适用于本公司的所有开发人员，包括数据库、网页及应用程序开发人员，及有 关的程序测试人员。 1.3. 引用标准 GB/T 8566-1995 信息技术 软件生存期过程 GB/T 8567-1988 计算机软件产品开发文件编写指南 1.4. 术语 GB/T 11457-1995 中所使用的术语适用于本规范。 第 2 页 代码编写规范 2. 代码编写规则 2.1. 注释 （1） 编写代码期间注释要求占程序总量15%以上。 （2） 每个模块顶部必须说明模块名称、功能描述、作者等。 （3） 每个过程、函数、方法等开头部分必须说明功能、参数、返回值、原数据和目标数 据数据结构等等。 （4） 变量定义的行末应当对变量给出注释。 （5） 程序在实现关键算法的地方应当给出注释 2.2. 变量、函数、过程、控件等命名规则 （1） 变量命名采用[作用范围][数据类型][自定义名称]规则定义，要求看到变量名就能 直观的看出其范围和数据类型。 （2） 函数、过程、方法、事件等命名应尽量做到观其名知其义。 （3） 控件的命名采用[控件类型][自定义名]规则定义,要求通过名字能直观看出控件类 型。 （4） 自定义命名空间规则，要求能顾名思义 2.3. 源代码规则 风格约定：采用缩进的格式保存程序的层次结构。要求能直观的看出循环、判断等层次结 构。 第 3 页