PHP代码书写规范-2014年6月26日资料.ppt

类的申明 当编写类时，应该遵守以下格式规则： 在方法名与其参数列表之前的左括号(间不要有空格- 左大括号{位于声明语句同行的末尾- 右大括号}另起一行，与相应的声明语句对齐，除非是一个空语句，}应紧跟在{之后 方法和方法之间以空格分隔 语句-简单语句 每行至多包含一条语句，例如 语句-复合语句 复合语句是包含在大括号中的语句序列，形如{ 语句 }。例如下面各段。 - 被括其中的语句应该较之复合语句缩进一个层次- 左大括号{应位于复合语句起始行的行尾；右大括号}应另起一行并与复合语句首行对齐。- 大括号可以被用于所有语句，包括单个语句，只要这些语句是诸如if-else或for控制结构的一部分。这样便于添加语句而无需担心由于忘了加括号而引入bug 语句-返回语句 一个带返回值的return语句不使用小括号()，除非它们以某种方式使返回值更为显见。例如： 语句-条件语句 语句-条件语句 注意：if语句总是用{和}括起来，避免使用如下容易引起错误的格式： 语句-循环语句 语句-循环语句 语句-循环语句 语句-选择语句 每当一个case顺着往下执行时(因为没有break语句)，通常应在break语句的位置添加注释。上面的示例代码中就包含注释/* falls through */。 语句-异常语句 空白-空行 空白-空格 空白-空格 命名-命名空间 命名-类 命名-类属性 命名-函数 命名-变量 命名-实例变量及常量 编程惯例 编程惯例 其他惯例-括号 其他惯例-大括号 其他惯例-大括号 其他惯例-大括号 其他惯例-返回值 其他惯例-返回值 目录 一、代码规范的重要性 三、PHP代码书写示例 二、代码规范的要求 代码书写示例 代码书写示例 代码书写示例 PHP代码书写规范 二零一二年六月二十六日 技术部-魏洪 目录 一、代码规范的重要性 三、PHP代码书写示例 二、代码规范的要求 代码规范的重要性 促进团队合作 降低维护成本 有助代码审查 减少BUG处理 有助自身成长 前言 代码规范比比皆是，但是很少有公司做好代码规范的。 作为一名程序员，本着提升自身开发能力、促进团队合作、减少BUG修改工作量、降低公司代码维护成本及促进管理人员代码审查的目的，希望所有人都能够重视起来。而且，我相信，如果我们代码规范能够做好的话，且不说开发水平提高多少，至少我们也会有很多出色开源项目 促进团队合作 一个项目大多都是由一个团队来完成，如果没有统一的代码规范，那么每个人的代码必定会风格迥异。且不说会存在多个人同时开发同一模块的情况，即使是分工十分明晰的，等到要整合代码的时候也有够头疼的了。大多数情况下，并非程序中有复杂的算法或是复杂的逻辑，而是去读别人的代码实在是一件痛苦的事情。统一的风格使得代码可读性大大提高了，人们看到任何一段代码都会觉得异常熟悉。显然的，规范的代码在团队的合作开发中是非常有益而且必要的。 减少BUG处理 很多IT人士将程序员比做农民工，这也的确非常的形象。就像刚才提到的，复杂的算法或逻辑只占项目中很小的比例，大多仅仅是垒代码的工作。可是越是简单，测试的bug反而是越多，而且是无穷无尽的bug。这里很大的程度上是由于代码不规范所致。? 没有规范的对输入输出参数的规范，没有规范的异常处理，没有规范的日志处理等等，不但导致了我们总是出现类似空指针这样低级的bug而且还很难找到引起bug的原因。相反，在规范的开发中，bug不但可以有效减少，查找bug也变得轻而易举。? 规范不是对开发的制约，而确实是有助于提高开发效率的。? 降低维护成本 随着我们项目经验的累积，会越来越重视后期维护的成本。而开发过程中的代码质量直接影响着维护的成本。因此，我们不得不从开发时便小心翼翼。? 在第一点中曾提到，规范的代码大大提高了程序的可读性，几乎所有的程序员都曾做过维护的工作，不用多说，可读性高的代码维护成本必然会大大降低。? 但是，维护工作不仅仅是读懂原有代码，而是需要在原有代码基础上作出修改。我们可以先想像没有统一风格的情况下，A完成开发以后，B进行维护加一段代码，过一段时间C又加一段代码。。。。。。直到有一天X看到那一大堆乱码想死的心都有了，维护也就进行不下去了。因此，统一的风格有利于长期的维护。? 另外，好的代码规范会对方法的度量、类的度量以及程序耦合性作出约束。这样不会出现需要修改一个上千行的方法或者去扩展一个没有接口的类的情况。规范的代码对程序的扩展性提高，无疑也是对维护人员的一个奖励。? 有助于代码审查 我个人是比较赞同进行代码审查的，这样可以及时纠正一些错误，而且可以对开发人员的代码规范作出监督。团队的代码审