zend编码规范要点.doc

附录A：ZEND FRAMWORK PHP代码标准 ? A.1.?总论 .?范围 本文为基于Zend Framework工作的程序员及团队，提供编码标准及策略，主要论及以下四个方面： ? l?????????PHP文件格式标准 l?????????命名规则 l?????????代码标准 l?????????文档标准 ? .?目的 在任何项目中，良好的代码标准都是不可缺少的。尤其当多名程序员在同一项目中进行合作时，拥有好的代码标标准，就可以提高工作质量，减少出错可能，同时使项目易于维护。 ? A.2. PHP文件格式 ?绪论 对于PHP的纯源代码文件（只仅含有PHP代码的文件），不需要包含结束符（”?”）。这一点并不被PHP规范所要求，但省略结束符可以防止文件尾部的空格偶然性地插入到输出结果中。 ? 重要：在Zend Framework PHP文档中（含其派生文档），不要使用_HALT_COMPILER()函数嵌入任意二进制数据。仅在安装特殊脚本的情况下，才能使用这一功能。 ? .?缩进 使用四个空格作为缩进，不要使用制表符。 ? .?行长 推荐的行长度为80字符，既程序员应尽量以80字符为限，保证其代码紧凑。但仍允许更长的代码行，PHP代码行的最大长度为120字符。 ? .?行结束符 在Unix文本文件中，每行都应包括行结束符，行结束符应使用换行符（LF），十六制代码为“0X”。 不要像在Macintosh机中那样使用回车符（CR，十六制代码“0X0D”）作为行结束符。 不要像在Windows系统中那样使用换行符和回车符结合的形式（CRLF，“0x0D, 0x”）。 ? A.3.?命名规则 .?类命名 在Zend Framework中，采用的类命名规则，直接基于储存它们的路径名。在Zend Framework的根目录“Zend/”下，储存着按等级次序排列着的全部类。 ? 类命名可以使用字母和数字，但并不推荐使用数字，下划线仅用于替代路径分隔符“/”，例如：文件名为“Zend/Db/Table.php”，应使用对应的类命名“Zend_Db_Table”。 ? 如果一个类名由多个词组成，每个词的首字母应大写，不允许出现连续的大字字母。比如：类名“Zend_PDF”是错误的，而“Zend_Pdf”是正确的。 ? 由Zend公司或其合作公司授权和发布的Zend Framework类，必定以“Zend_”开头，并一定按其等级，存储在根目录“Zend/”下相应路径中。 ? 以下为正确的类名： Zend_Db ? Zend_View ? Zend_View_Helper 重要：基于Zend Framework运行，但并不属于Zend Framework的源代码，既由最终用户而非其Zend合作公司编写的源代码，不能以“Zend_”开头。 ? .?接口命名 ? 接口类的命名标准与其它类相同，但必须以“Interface”结尾，如下例： Zend_Log_Adapter_Interface Zend_Controller_Dispatcher_Interface .?文件命名 ? 对于其它文件的命名，可以使用字母、数字、下划线“_”和连接符“-”，不能使用空格。 ? 任何含有PHP代码的文件，必须使用扩展名“.PHP”，以下的例子是一些正确的文件名（对应上一部分所讨论的类名）。 Zend/Db.php ? Zend/Controller/Front.php ? Zend/View/Helper/FormRadio.php 文件的路径和名称必须与相关类名相对应。 ? .函数和方法命名 函数名只能使用字母和数字，但不推荐使用数字，不可以使用下划线。 ? 函数名必须以小写字母开头。当一个函数名中包括多个词，每个词的首字母应大写。这种方法一般被称为“studlyCaps”?or?“camelCaps”。 ? 函数名应详细，兼顾详细和实用，以便提高代码的可读性。 ? 如下，为正确的函数名： filterInput() ? getElementById() ? widgetFactory() 在进行面向对象的编程中，相应的方法名称前应加上前缀“get”或“set”。当使用设计模式时，如单子模式(singleton pattern)或工厂模式(factory pattern)，方法名称中应包括模式名称，以便增加代码的可读性。 ? 尽管在Zend Framework中允许使用全局函数（“浮点函数——floating function”），但我们建议您不要这样做，你可以把这些函数包含在一个静态类中。 ? .变量命名 变量名可以包括数字和字母，不能使用下划线，同时不推荐使用数字。 ? 对于一个类成员变量，如果其类型为“private”或“protected”，则其函