附录 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.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. 数字索引数组
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.  适用范围

本文档提供的代码格式和文档的指南是给参与 Zend Framework 的个人和团队使用的,许多使用 Zend Framework 的开发者 也发现编码标准很有用,因为他们的代码风格和 Zend Framework 的代码保持一致。值得注意的是它要求切实努力来全面 详细说明编码标准。 注:有时候开发者认为在最详细的设计级别上标准的建立比标准所建议的更重要。Zend Framework 编码标准的指南 实践上很好地工作于 ZF 项目。你可以根据我们的 license 中的条款来修改或使用它们。

ZF 编码标准的话题包括:

  • PHP File 文件格式

  • 命名约定

  • 编码风格

  • 注释文档

B.1.2.  目标

编码标准对任何开发项目都很重要,特别是很多开发者在同一项目上工作。编码标准帮助确保代码的高质量、少 bug 和容易维护。