PHP专业级编程规范整理.doc

PHP 专业级编程规范整理专业级编程规范整理 目录 1 1目的目的2 2 2使用角色使用角色 2 3 3适用范围适用范围 2 4 4文档格式定义文档格式定义.2 5 5命名命名2 5.1命名的统一原则2 5.2常量命名2 5.3变量命名2 5.4子程序命名3 5.5接口命名3 5.6类命名3 5.7网站默认首页命名4 5.8文件命名4 5.9数据库方面命名4 6注释注释4 6.1总原则4 6.2规范4 6.2.1类的注释4 6.2.2接口的注释5 6.2.3子程序的注释5 7代码书写风格代码书写风格.6 7.1总原则6 7.2控制结构6 7.3单条语句7 7.4注释8 7.5子程序8 7.6类9 8PHP 性能规范性能规范.9 1 1目的目的 提高开发效率；降低程序的复杂度；提高代码可读性。 2 2使用角色使用角色 3 3适用范围适用范围 所有的 PHP 程序开发人员，PHP 代码质量检测人员 4 4文档格式定义文档格式定义 实例：实例： 建议规范，建议规范，如下形式的语句为建议性的规范，不强制要求（包括字体颜色与“（建议） ”双标识）： 用空行进行段落分隔（建议） 。 5 5命名命名 5.1 命名的统一原则 反映现实世界的问题 5.2 常量命名 具名常量是根据所代表的抽象实体而不是它所代表的数字来命名 全部大写，使用“_” 分隔单词 例子： DEFINE(CMS_ROOT, DIRNAME(_FILE_); 5.3 变量命名 全局变量以“g_”开头，非全局变量不要以“g_”开头 例子： $g_staticDel $memberCount 变量名反映了现实世界的问题 充分描述此变量的用途 所有的“临时”变量都重新命以更有意义的名字 例子： $discriminant = sqrt( pow( b, 2 ) - 4*a*c ); $root0 = ( -b + $discriminant ) / ( 2*a ); $root1 = ( -b - $discriminant ) / ( 2*a ); 以小写字母开头，从第二个单词开始，每个单词的第一个字母大写，其余小写 例子： $memberIndex 避免出现字母完全相同，仅大小写不同的命名 不允许在命名的结尾使用下划线 不要出现单字母的变量，如 i,j,k（只有在控制循环数时且循环代码条数在 3 条以 内，才可以考虑使用） 循环下标的名字要有意义（如果循环的长度超出了一两行代码或者出现了嵌套循 环，那么就应该是 i、j 或者 k 以外的其他名字） 例子： for ( $teamIndex = 0; $teamIndex setName( ); public function getName() return $_name; public function isVip() public function setName( $name ) $this-$_name = $name; 5.7 网站默认首页命名 index.html,index.shtml,index.php(根据实际需要，尽量按顺序选择) 5.8 文件命名 文件名全部小写 存类的文件名要与类名保持一致，文件名格式为：classname.class.php 一个文件存储一个类 5.9 数据库方面命名 表 ：项目英文缩写_T_表实际用途 视图：项目英文缩写_V_视图实际用途 过程：项目英文缩写_P_过程实际用途 函数：项目英文缩写_F_函数实际用途 序列：项目英文缩写_S_序列实际用途 主键：项目英文缩写_PK_表名_主键实际用途 索引：项目英文缩写_I_表名_索引实际用途 6注释 6.1 总原则 注释应该用中文清晰表达意思。应该能够使程序看起来更清晰，更容易理解。如 果某一段程序不值得写文档，那么可能它是无效的代码 注释要尽量简明，避免装饰性的、标语式的注释 注释不但要说明做什么，还应当说明为什么要这样做。最好先写注释表明要做什 么，再进行编码 另起一行的注释，要写在被注释程序的上一行 单行注释使用“/”,多行注释使用“/*/” （建议） 6.2 规范 6.2.1 类的注释 类型的用途、目的。包括其它别人可能感兴趣的介绍 已知的 Bug。当然最好是修正所有的错误，但是有时可能暂时还没有办法修 正错误，或暂时没有时间精力去修改 开发和维护该类的历史列表。记录每一次修改的作者、日期、修改的内容 对主要的算法必须加以解释说明，主要的流程必须给出引导性的说明 标准格式 /* * description 描述类的功能、用途、现存 BUG，设计方法。 * author 作者姓名 * version 最后修改日期（日期格式建议采用：年-月-日格式，例如：2008- 04-05） */ 如果对已经版本化的类进行了修改，需要按照如下格式为每一次修改附加修改 历史记录： * modify * 修改人 + 修改日期（日期格式建议采用：年-月-日格式，例如：2008-04- 05） * 修改说明 举例如下： /* * description 此类实现操作数据库的功能 * author 张三 * version 2008-04-05 * * modify * 李四 + 2008-05-17 * 增加事务处理方法 * * modify * 王六 + 2008-07-08 * 修改构造函数，增加只声名一次数据库联接的功能 */ Class Database 对类的每一个接口注释，注释内容不是说明实现细节，而是说明接口的意图 及使用方法。类似子程序的注释风格 6.2.2 接口的注释 接口的注释风格基本与类的注释风格相同 在别人使用接口之前，必须了解接口所包含的概念。检验一个接口是否应该 定义的简单方法是：你是否能够容易的描述接口的用途 接口如何应当和不应当被使用。开发者需要知道该接口如何被使用，也希望 知道该接口不能被怎样使用 6.2.3 子程序的注释 子程序执行了什么功能，为什么要这样处理 子程序对输入、输出数据的说明，子程序的局限性、算法来源，子程序的错 误处理情况，存在的 BUG，其它可行方案 标准格式： /* * description 描述此子程序的功能，存在的 BUG，算法来源，其它可 行方案 *example 使用实例（建议） * author 作者姓名 * version 最后修改时间 * param 类型 输入参数名 ：作用 * 列举状态或标识性参数的可能取值及所代表的意义 * return 类型 输出的结果所代表的意义 */ 举例： /* * 此子程序实现发送邮件的功能 * *example * $isSendSuccess = sendmail( , , * 论坛通知, 欢迎光临论坛, 1 ) * if ($isSendSuccess) * echo 发送成功; * * else * echo 发送失败; * * * author 刘七 * version 2008/07/12 * * param string $mailFrom : 从哪个 email 发出 * param string $mailTo : 发送到哪个 email * param string $mailTitle : email 的主题 * param string $mailContent : email 的内容 * param int $mailType : email 的类型 * 1 HTML 格式 * 0 普通文本格式 * return 类型 输出的结果所代表的意义 */ function sendmail( $mailFrom, $mailTo, $mailTitle, $mailContent, $mailType ) 7代码书写风格 7.1 总原则 基本原理：好的布局凸现程序的逻辑结构 一行代码尽量简短，并且保证一行代码只做一件事。那种看似技巧性的冗长 代码只会增加代码维护的难度。保证不必左右拉动滚动条来阅读一整行代 码，将会使你的代码更加可读，这一点包括注释 使用圆括号来界定操作的顺序。不要让别人判断复杂的操作优先级 合理使用空行，划分逻辑处理 代码缩进使用 TAB 键(四个空格)或者四个空格 建议遵循三十秒原则。如果另一个程序员无法在三十秒之内了解你的函数做 了什么，如何做以及为什么要这样做， 那就说明你的代码是难于维护的，必须得到提高 7.2 控制结构 单语句代码块的格式要与多语句代码块的格式统一 段落之间要使用空行（建议） 对于复杂的表达式，将条件分隔放在几行上 例子： /多语句代码块 for ( $i = 0; $i ; ) / 7.3 单条语句 用空格使语句显得清楚（建议） 使用空格会让逻辑表达式更易读（建议） 例子： while ( $pathName $startPath + $position ; ) / 使用空格让数组引用更容易读（建议） 例子： $grossRate census $groupId , $gender, census $groupId , $ageGroup 使用空格让子程序参数更容易读（建议） 例子： getCensus( $inputFile, $empCount, $empData, $maxEmps, $inputError ) 格式化后续行 使后续行明显 将子程序调用的后续行按标准量缩进（4 个空格或用 TAB 键缩进） 将控制语句的后续行缩进以标准的空格数（4 个空格或用 TAB 键缩进） 例子： /example 1: $totalBill = $totalBill + $customerPurchases $customerId + SalesTax( $customerPurchases $customerId ); /example 2: $totalBill = $totalBill + $customerPurchases $customerId + SalesTax( $customerPurchases $customerId ); /example 3: getCensus( $inputFile, $empCount, $empData, $maxEmps, $inputError ); /example 4: getCensus( $inputFile, $empCount , $empData, $maxEmps, $inputError ); /example 5: while ( $pathName $startPath + $position != ; & ( ( $startPath + $position ) = $pathNameMaxLength) / 每行仅写一条语句 每行只声明一个变量 每行只声明一个常量 变量声明应尽量接近其首次使用的位置 合理组织声明顺序 可以按类型分组 7.4 注释 单行注释使用“/”,多行注释使用“/*/” （建议） 注释的缩进要与相应代码一致 每行注释用至少一个空行分开 7.5 子程序 用空行分隔子程序的各部分 请在子程序的头、数据和常量名声明（如果有的话）以及子程序体之间插 入空行 将子程序参数按标准缩进 可选的子程序头布局有：任意布局、行尾布局或标准缩进。在大多数情况 下，标准缩进更准确、连贯、可读、易维护 7.6 类 8PHP 性能规范 使用$rowid方式取数据，不要使用$rowid方式。 原因：$rowid的效率是$rowid的 7 倍。 纯字符串使用单引号包含。 原因：PHP 会在双引号包围的字符串中搜寻变量，单引号则不会。 删除未使用的变量 原因：仅定义一个局部变量而没在函数中调用它，同样会减慢速度（其程度 相当于递增一个局部变量） 。PHP 大概会检查看是否存在全局变量。 执行 for 循环之前确定最大循环数，不要每循环一次都计算最大值。 循环内部不要声明变量，尤其是大变量：对象(语言通用)。 执行字符串替换前用 s