DoitPHP编码规范.doc

DoitPHP编码规范

引言
本规范基于PHPPEAR编码规范及PHPDocumentor注释规范等编程原则组成，融合并提炼了开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格。以达到在团队协作中，事半功倍的开发效率。为了与时俱进，根据客观需求，本文档会不定期更新。
作者：tommy<[e-mail]>
版权：DoitPHPGroup<www.doitphp.com>
更新日期：2010年9月23日

二、适用范围
如无特殊说明，以下规则要求完全适用于DoitPHP项目(注：Doitphp的PHP框架文件，而非使用DoitPHP所开发的PHP项目)。如果你喜欢以下编码规范，也可以用在其它PHP开发项目。

标准化的重要性和好处
“不以规矩，不成方圆”，当一个软件项目尝试着遵守公共一致的标准时，可以使参与项目的开发人员更容易了解项目中的代码、弄清程序的状况。使新的参与者可以很快的适应环境，防止部分参与者出于节省时间的需要，自创一套风格并养成终生的习惯，导致其它人在阅读时浪费过多的时间和精力。而且在一致的环境下，也可以减少编码出错的机会。缺陷是由于每个人的标准不同，所以需要一段时间来适应和改变自己的编码风格，暂时性的降底了工作效率。从使项目长远健康的发展以及后期更高的团队工作效率来考虑暂时的工作效率降低是值得的，也是必须要经过的一个过程。标准不是项目成功的关键，但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。
1.程序员可以了解任何代码，弄清程序的状况
2.新人可以很快的适应环境
3.防止新接触PHP的人出于节省时间的需要，自创一套风格并养成终生的习惯
4.防止新接触PHP的人一次次的犯同样的错误
5.在一致的环境下，人们可以减少犯错的机会
6.程序员们有了一致的敌人

PHP编码规范与原则
文件格式

1.1、文件编码：文件编码统一为UTF-8(注:非UTF-8+BOM)。
1.2、定界符：PHP代码必须以完整的形式来定界即：“<?php?>”。而短定界符“<??>”将禁止使用。对于只含有php的代码文件,建议将文件结尾处的“?>”忽略掉，防止多余空格或其它字符影响代码。
1.3、代码缩进：缩进将使用制表符，不推荐使用空格（通常的缩进由四个空格组成）。主要目的是：为了尽可能地简单，高效地编写代码。虽然在不同的编辑器里，TAB制表符的长度是不一样的,我们不会为了不必要的“编码优美”而牺牲程序的开发效率。本缩进规范也适用于JavaScript中的函数、类、逻辑结构、循环等。
1.4、代码长度：每行代码长度应控制在80个字符以内，最长不超过120个字符（具体视实际情况而定，量力而行，情况特殊可以不遵守本规定）。
1.5、代码内容：每行结尾不允许有多余的空格或TAB制表符（确保你的编辑器保存文件为Unix格式，这意味着行是以换行符终止的）。禁止一个php文件出现两个或多个类，不过允许其它php代码存在。除了语言包注释配置文件,其它地方不能有中文。
1.6、代码注释：文件要有清晰的代码注释，注释风格采用phpDocumentor标准（相关网址:http://www.phpdoc.org/)

命名约定

命名是程序规划的核心。古人相信只要知道一个人真正的名字就会获得凌驾于那个人之上的不可思议的力量。只要你给事物想到正确的名字，就会给你以及后来的人带来比代码更强的力量。
名字就是事物在它所处的生态环境中一个长久而深远的结果。总的来说，只有了解系统的程序员才能为系统取出最合适的名字。如果所有的命名都与其自然相适合，则关系清晰，含义可以推导得出，一般人的推想也能在意料之中。
就一般约定而言，类、函数和变量的名字应该总是能够描述让代码阅读者能够容易的知道这些代码的作用。形式越简单、越有规则，就越容易让人感知和理解。应该避免使用模棱两可，晦涩不标准的命名。
2.1、文件名：文件名由字母数字和下划线组成，为方便和兼容不同操作系统，推荐字母统一小写。短横线("-")和空格是绝对不允许的。
注：controller文件,model文件,widget文件除外，此三种文件将采用驼峰命名法则。
(1)controller文件名:Controller文件名字和内容中类的名字相同(大小字母也一致的相同）,如建立index的controller文件，其名字为IndexController.class.php。解释：index首字母要大写，后再加上Controller,注意这个Controller也是首字母大写的。
(2)model文件名:model文件命名采用驼峰命名法则。model文件内容类的名字和文件名要一致,如建一个新Model文件，假设为demo的model文件。文件名字为：DemoModel.