PHP程序编码规范标准20020123.doc

PHP程序编码规范标准最后修改日期: 200-01-23 PHP编程标准是经由Todd Hoff许可，基于《C++ 编程标准》为PHP而重写的，作者为Fredrik Kristiansen， 使用本标准，如果您想拷贝一份留做自用的话，那是完全免费的，这也是我们制作它的原因。假如您发现了任何的错误又或者是有任何的改进，请您给笔者发一个email，以便笔者将它们合并到最新更新中去。 介绍 标准化的重要性 解释 认同观点 命名规则 合适的命名 缩写词不要全部使用大写字母 类命名 类库命名 方法命名 类属性命名 方法中参数命名 变量命名 引用变量和函数返回引用 全局变量 定义命名 / 全局常量 静态变量 函数命名 php文件扩展名 文档规则 评价注释 Comments Should Tell a Story Document Decisions 使用标头说明 Make Gotchas Explicit Interface and Implementation Documentation 目录文档 复杂性管理规则 Open/Closed Principle sever configuration 类规则 Different Accessor Styles 别在对象架构期做实际的工作 Thin vs. Fat Class Interfaces 短方法 进程规则 Use a Design Notation and Process Code Reviews Create a Source Code Control System Early and Not Often Create a Bug Tracking System Early and Not Often Honor Responsibilities 格式化 大括号 {} 规则 缩进/制表符/空格 规则 小括号、关键词和函数 规则 If Then Else 格式 switch 格式 continue,break 和 ? 的使用 每行一个语句 声明块的定位 杂项 不要不可思议的数字 错误返回检测规则 不要采用缺省值测试非零值 布尔逻辑类型 通常避免嵌入式的赋值 重用您和其他人的艰苦工作 使用if (0)来注释外部代码块 其他杂项 Pear-Indenting_ Pear-Control Structures_ Pear-Function Calls Pear-Function Definitions Pear-Comments_ Pear-Including Codes Pear-PHP Code Tags_ Pear-Header Comment Blocks_ Pear-Using CVS Pear-Example URLs Pear-Naming Conventions_ 介绍 标准化的重要性 标准化问题在某些方面上让每个人头痛，让人人都觉得大家处于同样的境地。这有助于让这些建议在许多的项目中不断演进，许多公司花费了许多星期逐子字逐句的进行争论。标准化不是特殊的个人风格，它对本地改良是完全开放的。优点当一个项目尝试着遵守公用的标准时，会有以下好处： 程序员可以了解任何代码，弄清程序的状况 新人可以很快的适应环境 防止新接触php的人出于节省时间的需要，自创一套风格并养成终生的习惯 防止新接触php的人一次次的犯同样的错误 在一致的环境下，人们可以减少犯错的机会 程序员们有了一致的敌人 :-) 缺点现在轮到坏处了: 因为标准由一些不懂得php的人所制定，所以标准通常看上去很傻 因为标准跟我做的不一样，所以标准通常看上去很傻 标准降低了创造力 标准在长期互相合作的人群中是没有必要的 标准强迫太多的格式 总之人们忽视标准 讨论 许多项目的经验能得出这样的结论：采用编程标准可以使项目更加顺利地完成。标准是成功的关键么？当然不。但它们可以帮助我们，而且我们需要我们能得到的所有的帮助！老实说，对一个细节标准的大部分争论主要是源自自负思想。对一个合理的标准的很少决定能被说为是缺乏技术性的话，那只是口味的原因罢了。所以，要灵活的控制自负思想，记住，任何项目都取决于团队合作的努力。 解释 惯例在本文档中使用“要”字所指的是使用本规范的所有项目需要遵守规定的标准。 使用“应该”一词的作用是指导项目定制项目细节规范。因为项目必须适当的包括 (include），排除(exclude)或定制（tailor）需求。 使用“可以”一词的作用与“应该”类似，因为它指明了可选的需求。在本文档中使用“要”字所指的是使用本规范的所有项目需要遵守规定的标准