php开发标准研讨.docVIP

PHP编码规范? 目录? 1?概述 1.1?目标? 1.2?原则? 1.3?参考 2?约定规则 ? 2.1?给代码注释? 2.2?让代码分段和缩进 2.3?在代码中使用空白 2.4?遵循?30?秒法则 2.5?每行只做一件事情 2.6?说明运行顺序 2.7?公共和保护接口最小化原则 3?命名规范 4?注释规范 5?格式规范 5.1?排版格式 5.2?代码样式 5.3?文档化 6?开发规范? 6.1?架构函数 6.2?异常处理规范 6.3?测试维护规范 6.4?性能约束 一、概述? 1.1? 适用范围? 本文档提供的代码格式和文档的指南是给参与PHP的个人和团队使用的。?注：有时候开发者认为在最详细的设计级?别上标准的建立比标准所建议的更重要。? PHP?编码标准的话题包括：? 文件格式? 命名约定? 编码风格? 注释文档? 格式规范? 开发规划? 1.2? 目标? 本编码规范的形成旨在为?PHP?开发建立一个可操作的编程?标准、约定和指南，以规范我们的代码开发工作。提高代码的可读性，提高系统的健壮性、稳定性、?可靠性。 通过遵循这些程序设计标准，作为一个?PHP 开发者的生产效率会有显著提高。 经验证明，若?从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。 最后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。? 1.3? 原则? 本编码规范遵循几个主要原则：? *? 可维护性；? *? 文档化；? *? 提高效率；? 1.4? 参考? 在编写本编码规范的时候，参考了? PHP 编码规范? [? 第一版? ]? PHPDocument? 使用说明规范? Java 编码规范? PHP? 编程标准 ? 二、约定规则? 2.1? 给代码注释? 记住：如果你的代码不值得注释，那么它就不值得保留。当正确地使用了本文提到的注释标准和方针，就可以大幅度地提高代码质量。 2.2? 让代码分段和缩进? 一种提高代码可读性的方法是给代码分段，?换句话说，?就是在代码块内让代码缩进。?所有在括号? {? 和? }?之内的代码，构成一个块。基本思想是，块内的代码都应统一地缩进去一个单位。缩进由TAB组成 。? 一行? 80? 字符以内是比较合适，在有些情况下，长点也可以,? 但最多为? 120? 个字符。? 2.3? 行结束标志? ??结束标志遵循? Unix? 文本文件的约定，?行必需以单个换行符?（LF）?结束。?换行符在文件中表示为? 10，?或?16?进制的? 0x0A。? 注：不要使用? 苹果操作系统的回车（0x0D）或? Windows? 电脑的回车换行组合如（0x0D,0x0A）。? 2.4? 在代码中使用空白? 在代码中加入几个空行，也叫空白，将代码分为一些小的、容易理解的部分，可以使它更加可读。建?议采用一个空行来分隔代码的逻辑组，例如控制结构，采用两个空行来分隔成员函数定义。没有空白的代码很难读，很难理解。? 2.5? 遵循?30?秒法则 其他的程序员应能在少于30秒钟的时间内完全理解你的成员函数，理解它做什么，为什么这样做，它是怎样做的。如果他们做不到，说明你的代码太难维护，应加以改进。30秒钟，明明白白。 一个好的经验法则是：如果一个成员函数一个屏幕装不下，那么它就很可能太长了。 2.6? 每行只做一件事情 每一行代码只做一件事情。在依赖于穿孔卡片的计算机发展的早期，想让一行代码完成尽量多的功能?的想法是可以理解的。若想在一行里做多件事情，就会使代码难于理解。为什么要这样呢？我们应使?代码尽量容易理解，从而更容易维护和改进。正如同一个成员函数应该并且只能做一件事一样，一行?代码也只应做一件事情。? 此外，应让代码在一个屏幕内可见。?也不应向右滚动编辑窗口来读取一整行代码，包括含有行内注释?语句的代码。? 2.7? 说明运行顺序 提高代码可读性的一个相当简单的方法是使用圆括号来说明?PHP?代码运行的准确顺序。?如果为了理解?你的源码而必须了解编程语言的操作顺序，?那么这说明源码中一定有什么重要的东西做的不对。?这大?多是 AND? 或者? OR? 其它几个比较关系处产生的逻辑比较上的问题。? 注意：如果你象前文所建议的那样，采用短小单独的命令行，那么就不会产生这个问题。? 2.8? 公共和保护接口最小化原则? 面向对象程序设计的基本点之一是最小化一个类的公共接口。这样做有几个理由：? *? 可学习性。要了解如何使用一个类，只需了解它的公共接口即可。公共接口越小，类越容易学?习。? *? 减少耦合。当一个类的实例向另一个类的实例或者直接向这个类发送一条消息时，这两个类变得耦合起来。最小化公共接口意味着将耦合的可能降到最低。? *? 更大的灵活性。这直接与耦