Zend Framework的PHP编码规范

1. 概述... 2

1.1. 文档主要内容... 2

1.2. 目标... 2

2. PHP文件格式要求... 2

2.1. 一般要求... 2

2.2. 缩排... 2

2.3. 行最大字符数... 2

2.4. 行结束符... 3

3. 命名规范... 3

3.1. 类的命名... 3

3.2. 接口类的命名... 4

3.3. 文件命名... 4

3.4. 函数与方法的命名... 4

3.5. 变量命名... 5

3.6. 常量命名... 5

4. 编码风格... 6

4.1. PHP代码定界符... 6

4.2 字符串书写风格... 6

4.3. 数组... 7

4.4. 类... 8

4.5. 函数与方法... 9

4.6. 控制语句... 11

4.7. 内部文档化... 13

1. 概述

1.1. 文档主要内容

本文档是对PHP开发的规范性提供指导和建议，主要内容包括：

l        PHP文件格式要求

l        命名规范

l        编码风格规范

l        代码内文档化要求

1.2. 目标

编码规范对于任何一个开发项目都是很重要的，尤其是多人协作的情况，良好的编码规范意味着代码高质量、较少bug，以及易于维护。

2. PHP文件格式要求

2.1. 一般要求

对于只包含PHP代码的文件，不允许使用PHP结束标签（”?>”），尽管PHP语法并不要求必须这么做，但去掉这个结束标签，可以避免尾部的空白字符意外输出，造成不必要的影响。

重要：虽然在PHP里可以通过 __HALT_COMPILER() 来包含任意的二进制数据，但在本规范里禁止这么做，只有在某些安装了特殊脚本的情况下才允许这么做。

2.2. 缩排

缩进的时候使用4个SPACE字符（键），不要使用TAB字符（键）。

2.3. 行最大字符数

每行不要超过80个字符，即，在实际开发过程中每行的代码尽量不要超过第80列这个边界，稍微超过也可以，PHP代码每行最大字符数是120。

2.4. 行结束符

行结束符采用UNIX文本文件标准，即每行以“换行符（LF）”结束，在ASCII码中，换行符是的十进制值为10，十六进制值为0x0A。

不要使用Macintosh系统的标准：以回车符（CR，十六进制值是0x0D）为行结束符。

也不要使用Windows系统的标准：以回车/换行（CRLF，0x0D, 0x0A）为行结束符。