ZF编码规范.doc

附录?B.?Zend Framework PHP 编码标准 B.1. 绪论 B.1.1. 适用范围 B.1.2. 目标 B.2. PHP File 文件格式 B.2.1. 常规 B.2.2. 缩进 B.2.3. 行的最大长度 B.2.4. 行结束标志 B.3. 命名约定 B.3.1. 类 B.3.2. 接口 B.3.3. 文件名 B.3.4. 函数和方法 B.3.5. 变量 B.3.6. 常量 B.4. 编码风格 B.4.1. PHP 代码划分（Demarcation） B.4.2. 字符串 B.4.2.1. 字符串文字 B.4.2.2. 包含单引号（）的字符串文字 B.4.2.3. 变量替换 B.4.2.4. 字符串连接 B.4.3. 数组 B.4.3.1. 数字索引数组 Numerically Indexed Arrays B.4.3.2. 关联数组 B.4.4. 类 B.4.4.1. 类的声明 B.4.4.2. 类成员变量 B.4.5. 函数和方法 B.4.5.1. 函数和方方声明 B.4.5.2. 函数和方法的用法 B.4.6. 控制语句 B.4.6.1. If / Else / Elseif B.4.6.2. Switch B.4.7. 注释文档 B.4.7.1. 格式 B.4.7.2. 文件 B.4.7.3. 类 B.4.7.4. 函数 B.1.? 绪论 B.1.1.? 适用范围 PHP File 文件格式 命名约定 编码风格 注释文档 B.1.2.? 目标 B.2.?PHP File 文件格式 B.2.1.? 常规 重要： 由 __HALT_COMPILER() 允许的任意的二进制代码的内容被 Zend Framework PHP 文件或由它们产生的文件禁止。这个功能的使用只对特殊的安装脚本开放。 B.2.2.? 缩进 B.2.3.? 行的最大长度 B.2.4.? 行结束标志 不要使用 Macintosh 电脑的回车如（0x0D）。 不要使用 Windows 电脑的回车换行组合如（0x0D,0x0A）。 B.3.? 命名约定 B.3.1.? 类 类名只允许有字母数字字符，但不鼓励使用数字。下划线只允许做路径分隔符，例如 Zend/Db/Table.php 文件里对应的类名称是 Zend_Db_Table。 如果类名包含多个单词，每个单词的第一个字母必须大写，连续的大写是不允许的，例如 “Zend_PDF” 是不允许的，而 Zend_Pdf 是可接受的。 由 Zend 或其参与 Zend Framework 项目的伙伴公司发行的类必须以 Zend_ 开头并且必须按等级放在 Zend/目录下。 可接受的类名的例子： Zend_Db Zend_View Zend_View_Helper 重要： 最终用户写的代码，不要以 Zend_ 开头。 B.3.2.? 接口 Zend_Log_Adapter_Interface Zend_Controller_Dispatcher_Interface B.3.3.? 文件名 包含任何 PHP 代码的任何文件必须以 .php 扩展名结尾。这些例子给出可接受的文件名，它们包含的类名都在上述章节的例子中： Zend/Db.php Zend/Controller/Front.php Zend/View/Helper/FormRadio.php 文件名必须遵循上述的对应类名的规则。 B.3.4.? 函数和方法 函数名总是以小写开头，当函数名包含多个单词，每个子的首字母必须大写，这就是所谓的 “驼峰” 格式。 我们鼓励使用冗长的名字，这样容易理解代码。 这些是可接受的函数名的例子： filterInput() getElementById() widgetFactory() 对于面向对象编程，对象的访问器总是以 get 或 set 为前缀。当使用设计模式如 单态模式（singleton）或工厂模式（factory），方法的名字应当包含模式的名字，这样容易从名字识别设计模式。 在对象中的方法，声明为 private 或 protected 的， 名称的首字符必须是一个单个的下划线，这是唯一的下划线在方法名字中的用法。声明为 public 的从不以下划线开头。 全局函数 (floating functions) 允许但不鼓励，建议把这类函数封装到静态类里。 B.3.5.? 变量 声明为 private 或 protected