ThinkPHP编码规范.docVIP

编码规范 编写：扬速技术部研发组 最后更新：2015-8-5 目录 1 概述 4 1.1目标 4 1.2原则 5 1.3参考 5 2约定规则 5 2.1给代码注释 5 2.2让代码分段和缩进 6 2.3在代码中使用空白 6 2.4遵循 30 秒法则 6 2.5每行只做一件事情 7 2.6说明运行顺序 7 2.7公共和保护接口最小化原则 7 3命名规范 8 4注释规范 15 5格式规范 20 5.1排版格式 20 5.2代码样式 21 5.3 .文档化 23 6 开发规范 24 6.1 架构函数 24 6.2 异常处理规范 24 6.3测试维护规范 25 6.4性能约束 25 概述 1.1 适用范围 本文档提供的代码格式和文档的指南是给扬速技术部php研发（以下简称研发组）组使用的，注：有时候开发者认为在最详细的设计级 别上标准的建立比标准所建议的更重要。 编码标准的话题包括： 文件格式 命名约定 编码风格 注释文档 格式规范 开发规划 1.2 目标 本编码规范的形成旨在为研发组开发和以后在此之上的应用开发建立一个可操作的编程 标准、约定和指南，以规范我们的代码开发工作。提高代码的可读性，提高系统的健壮性、稳定性、 可靠性。通过遵循这些程序设计标准，作为一个 PHP 开发者的生产效率会有显著提高。经验证明，若 从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。 最后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。 1.3 原则 本编码规范遵循几个主要原则： 可维护性； 文档化； 提高效率； 1.4 参考 在编写本编码规范的时候，参考了 PHP 编码规范 [ 第一版 ] PHPDocument 使用说明规范 Java 编码规范 PHP 编程标准 2000-11-16 Fredrik Kristiansen 2 约定规则 2.1 给代码注释 记住：如果你的代码不值得注释，那么它就不值得保留。当正确地使用了本文提到的注释标准和方针， 就可以大幅度地提高代码质量。 例： ?php /** * ThinkPHP Action控制器基类 抽象类 * @author liu21st liu21st@@date ${date} ${time} */ abstract class Action { //图实例对象 protected $view = null; /** * 架构函数 取得模板对象实例 */ public function __construct() { tag(action_begin,$this-config); //控制器初始化 if(method_exists($this,_initialize)) $this-_initialize(); } /** * 模板显示 调用内置的模板引擎显示方法， * @param string $content 输出内容 * @param string $prefix 模板缓存前缀 * @return void */ protected function display($content=,$prefix=) { $this-initView(); $this-view-display($prefix); } } 2.2 让代码分段和缩进 一种提高代码可读性的方法是给代码分段， 换句话说， 就是在代码块内三让代码缩进。 所有在括号 { 和 }之内的代码，｛｝各占一行成一个块。基本思想是，块内的代码都应统一地缩进去一个单位。缩进由四个空格组 成，禁止使用制表符 TAB 。 一行 80 字符以内是比较合适，在有些情况下，长点也可以, 但最多为 120 个字符。 2.3 行结束标志 行结束标志遵循 Unix 文本文件的约定， 行必需以单个换行符 （LF） 结束。 换行符在文件中表示为 10， 或 16 进制的 0x0A。 注：不要使用 苹果操作系统的回车（0x0D）或 Windows 电脑的回车换行组合如（0x0D,0x0A）。 2.4 在代码中使用空白 在代码中加入几个空行，也叫空白，将代码分为一些小的、容易理解的部分，可以使它更加可读。建