doitphp编码规范.doc

《doitphp编码规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、DoitPHP编码规范一、引言本规范基于PHPPEAR编码规范及PHPDocumentor注释规范等编程原则组成，融合并提炼了开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格。以达事半功倍的效果。为了与时俱进，根据客观需求，本文档会不定期更新。作者：tommy版权：DoitPHPGroup更新日期：2010年9月25日二、适用范围如无特殊说明，以下规则要求完全适用于DoitPHP项目(注：Doitphp的P

2、HP框架文件，而非使用DoitPHP所开发的PHP项目)。如果你喜欢以下编码规范，也可以用在其它PHP开发项目。三、标准化的重要性和好处“不以规矩，不成方圆”，当一个软件项目的开发遵守公共一致的标准时，整个团队成员形成并保持一致的编码风格，整个项目文件如同一人所写。每个程序员的代码都易于为他人所理解，提高了代码的可维护性，从而减少了软件的维护成本。同时使新的参与者可以很快的适应环境，从而最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成好的编码习惯，可以减少编码出错的机会,甚至

3、锻炼出更加严谨的思维。将规范“令之以文”是为了明确我们的编码标准。我们相信：标准不是项目成功的关键，但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。四、PHP编码规范与原则1、文件格式1.1、文件编码：文件编码统一为UTF-8(注:非UTF-8+BOM)。1.2、PHP代码标记：任何时候都要使用“”来定义你的PHP代码。而“”将禁止使用。对于只含有php的代码文件,建议将文件结尾处的“?>”忽略掉，防止多余空格或其它字符影响代码。1.3、缩进规则：缩进使用

4、4个空格，而不是TAB。这已经是PHP业界的标准了，我们也不会“逆历史潮流而动”。使用空格主要是为了代码美观整齐。因为在不同的编辑器里，TAB制表符的长度是不一样的，而空格则是一样的。使用TAB按下TAB键能解决的问题，使用空格则要按四次空格键，明显影响开发效率。目前很多编辑器默认一个TAB占用四个空格位置（占用几个空格，对此编辑器可以调节），如果是这样，为了提高开发效率，可以放心大胆地使用TAB。本缩进规范也适用于JavaScript中的函数、类、逻辑结构、循环等。1.4、代码内容：每行结尾不允

5、许有多余的空格或TAB制表符（确保你的编辑器保存文件为Unix格式，这意味着行是以换行符终止的）。除了语言包注释配置文件,其它地方不能有中文。1.5、代码注释：文件要有清晰的代码注释，注释风格采用phpDocumentor标准（相关网址:http://www.phpdoc.org/)131、命名约定命名是程序规划的核心。古人相信只要知道一个人真正的名字就会获得凌驾于那个人之上的不可思议的力量。只要你给事物想到正确的名字，就会给你以及后来的人带来比代码更强的力量。名字就是事物在它所处的生态环境中一个

6、长久而深远的结果。总的来说，只有了解系统的程序员才能为系统取出最合适的名字。如果所有的命名都与其自然相适合，则关系清晰，含义可以推导得出，一般人的推想也能在意料之中。就一般约定而言，类、函数和变量的名字应该总是能够描述让代码阅读者能够容易的知道这些代码的作用。形式越简单、越有规则，就越容易让人感知和理解。应该避免使用模棱两可，晦涩不标准的命名。2.1、文件名：文件名由字母数字和下划线组成，为方便和兼容不同操作系统，推荐字母统一小写。短横线("-")和空格是绝对不允许的。2.2、文件扩展名：php文

7、件扩展名为".php"（这个地球人都知道），不过下面几种情况例外：类文件扩展名为“.class.php”且文件命名和类名一致(字母大小写也要一致);配置文件扩展名为“.ini.php”;函数文件扩展名为“.fun.inc.php”;不能通过浏览器直接访问的php文件（用于被incldue调用的）扩展名建议为“.inc.php”。2.3、类名：类名只允许有字母，数字字符和下划线，在大部分情况下不鼓励使用数字和下划线。如果类名包含多个单词，每个单词的第一个字母必须大写（“驼峰”命名规则），连续的大写是

8、不允许的。接口类(interface)的定义必须遵循类名的定义规范，不同的是必须要以_Interface作为结尾。注：对于类名中使用下划线，在Zendframework的编码规范中，类名中使用“_”则表示一个目录。classDb_Mysql表示该类文件存放于Db目录下，类名中多一个“_”，意味着多一个目录。对此，我们也应推荐这个类的命名规范，所以不鼓励类名中使用下划线。2.4、函数名：函数名只允许由字母，数字或下划线组成，字母应当全部小写。函数名应该具有描述性，当由多个单词组成时，