PHP程序编码规范.PDFVIP

PHP程序编码规范 乐邦科技程序部 版本 1.2 杭州乐邦科技有限公司 - 程序部（TEL:0571 前言 目的： 了更好的便于规范 PHP 团队成员编码规范，统一编码风格，帮助大家更好的形成良好的编码风格。 适用范围： 本规范权限于乐邦科技程序部 PHP 团队内部适用。 标准化作用： 当一个项目尝试着遵守公共一致的标准时，可以使参与项目的开发人员更容易了解项目中的代码、 弄清程序的状况。使新的参与者可以很快的适应环境，防止部分参与者出于节省时间的需要，自创一套 风格并养成终生的习惯，导致其它人在阅读时浪费过多的时间和精力，而且在一致的环境下，也可以减 少编码出错的机会。 缺陷是由于每个人的标准不同，所以需要一段时间来适应和改变自己的编码风格，暂时性的降底了 工作效率。从使项目长远健康的发展以及后期更高的团队工作效率来考虑暂时的工作效率降低是值得的 ， 也是必须要经过的一个过程。标准不是项目成功的关键，但可以帮助我们在团队协作中有更高的效率并 且更加顺利的完成即定的任务。 1. 程序员可以了解任何代码，弄清程序的状况 2. 新人可以很快的适应环境 3. 防止新接触 PHP 的开发出于节省时间的需要，自创一套风格并养成终生的习惯 4. 防止新接触 PHP 的开发一次次的犯同样的错误 5. 在一致的环境下，可以减少犯错的机会 杭州乐邦科技有限公司 - 程序部（TEL:0571 PHP 编码规范 一、基本规范 1. 文件格式 1.1. 标签 PHP代码的编码格式使用不带 “字节顺序标记(BOM)”的UTF-8。 1.2. 编码 PHP代码使用 “长标签(?php?)”或者 “短输出式标签(?=?)” ，而不可使用其他标签。 2. 命名规则 2.1. 概述 常用命名规范： Pascal 命名规则 （帕斯卡） 将标识符的每个单词的首字母都大写。例如：BackColor Camel 命名规则 （骆驼式） 将标识符的首字母小写，而后面链接的单词的首字司都大写。例如：backColor LinuxC 命名规则 将所有字母都使用小写，使用 “_”作为每个词的分界。 命名必须有一定的意义，并且意义准确 ： 例如 ：有一个变量用于保存图书的数目 ，可以命名 mumber_of_book 或者 num_of_book 不建议使 用 i,j,n 等，因为它没有意义，也不建议使用number或book，因为意义不准确。 杭州乐邦科技有限公司 - 程序部（TEL:0571 2.2. 文件命名 类的文件的名称与类的名称保持一致，使用 Pascal 命名法。 如类 IndexAction ，对应的文件名称 IndexAction.php 视图文件命名使用驼峰命名方式，如 indexAction.php 配置文件名称全部小写，如：config.php 类库文件，助手文件和模型文件命名与类文件命名方式保持一致。 2.3. 类命名 类名命名方式使用 Pascal 命名方法，类名应该和文件名保持一致。 2.4. 接口命名 接口命名方式同类命名方式一致，习惯上名字前面加上大写的I。 2.5. 函数命名 函数命名方式一般为一个动词或者行为动词，使用驼峰命名方式命名，例如： FunctiongetExecutionTime(), 私有函数命名使用以 “_”开头。 注意：尽量使用有意义、描述性单词来命名函数名 ，避免使用单个字母来命名函数名。 常用的命名前缀：  Is - 询问  get - 获取  set - 设置  num- 数量 杭州乐邦科技有限公司 - 程序部（TEL:0571 2.6. 变量命名 变量命名尽量使用有意义的描述性词来命名变量，统一使用驼峰命名法来命名变量。 避免使用一些没有意义的缩写。 避免使用单个字母来命名变量。 2.7. 常量命名 常量命名统一全部使用大写字母和下划线来命名，不能使用小写字母。 3. 注释规则 3.1. 一般注释 单行注释：在语句结束后用 “//”解释该语句的具体作用 ，“//”后加一个空格，例如： 多行注释 ：使用 “/*”开始 ，并以 “*/”结束 ，用于