在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
看到一篇不错的php编码规范的文章,网址如下: http://hi.baidu.com/bozz_/item/7aab598ba79f785c850fab64 PHP编码规范if ( PRESIDENT_WENT_CRAZY == $foo) { start_thermo_nuclear_war(); } else if (WE_GOOFED == $foo) { refund_lotso_money(); } else if (THEY_DIDNT_PAY == $foo) { infinite_loop(); } else { happy_days_i_know_why_im_here(); } 4.2.9 true/false和0/1判断 遵循以下规则: a. 不能使用0/1代替true/false,在PHP中,这是不相等的; b. 不要使用非零的表达式、变量或者方法直接进行true/false判断,而必须使用严格的完整true/false判断; 如:不使用if ($a) 或者if (checka()) 而使用if (FALSE != $a)或者 if (FALSE != check()) 4.2.10 避免嵌入式赋值 在程序中避免下面例子中的嵌入式赋值: 不使用这样的方式: while ($a != ($c = getchar())) { process the character } 4.2.11 错误返回检测规则 检查所有的系统调用的错误信息,除非你要忽略错误。 为每条系统错误消息定义好系统错误文本,并记录错误LOG。 4.3 程序注释 每个程序均必须提供必要的注释,书写注释要求规范,参照PEAR提供的注释要求,为今后利用phpdoc生成php文档做准备。程序注释的原则如下: a. 注释中除了文件头的注释块外,其他地方都不使用//注释,而使用/* */的注释; b. 注释内容必须写在被注释对象的前面,不写在一行或者后面; 4.3.1 程序头注释块 每个程序头部必须有统一的注释块,规则如下: a. 必须包含本程序的描述; b. 必须包含作者; c. 必须包含书写日期; d. 必须包含版本信息; e. 必须包含项目名称; f. 必须包含文件的名称; g. 重要的使用说明,如类的调用方法、注意事项等; 参考例子如下: <?php // // +---------------------------------------------------------+ // | PHP version 4.0 | // +---------------------------------------------------------+ // | Copyright (c) 1997-2001 The PHP Group | // +---------------------------------------------------------+ // | This source file is subject to of the PHP license, | // | that is bundled with this packafile LICENSE, and is | // | available at through the world-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the and are unable to | // | obtain it through the world-wide-web,end a note to | // | [email protected] so we can mail you a immediately. | // +---------------------------------------------------------+ // | Authors: Stig Bakken <[email protected]> | // | Tomas V.V.Cox <[email protected]> | // | | // +---------------------------------------------------------+ // // $Id: Common.php,v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $ 4.3.2 类的注释 类的注释采用里面的参考例子方式: /** * @ Purpose: * 访问数据库的类,以ODBC作为通用访问接口 * @Package Name: Database * @Author: Forrest Gump [email protected] * @Modifications: * No20020523-100: * odbc_fetch_into()参数位置第二和第三个位置调换 * John Johnson [email protected] * @See: (参照) */ class Database { …… } 4.3.3 函数和方法的注释 函数和方法的注释写在函数和方法的前面,采用类似下面例子的规则: /** * @Purpose: * 执行一次查询 * @Method Name: Query() * * @Param: string $queryStr SQL查询字符串 * @Param: string $username 用户名 * * @Author: Michael Lee * * @Return: mixed 查询返回值(结果集对象) */ function($queryStr,$username) {……} 4.3.4 变量或者语句注释 程序中变量或者语句的注释遵循以下原则: a. 写在变量或者语句的前面一行,而不写在同行或者后面; b. 注释采用/* */的方式; c. 每个函数前面要包含一个注释块。内容包括函数功能简述,输入/输出参数,预期的返回值,出错代码定义。 d. 注释完整规范。 e. 把已经注释掉的代码删除,或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。 f. 例子: /** * @Purpose: * 数据库连接用户名 * @Attribute/Variable Name: db_user_name * @Type: string */ var db_user_name; 4.4 其他规范(建议) 4.4.1 php代码标记 所有的php程序代码块标记均使用 4.4.2 程序文件名、目录名 程序文件名和目录名命名均采用有意义的英文方式命名,不使用拼音或无意义的字母,同时均必须使用小写字母,多个词间使用_间隔。 4.4.3 PHP项目通常的文件目录结构 建议在开发规范的独立的PHP项目时,使用规范的文件目录结构,这有助于提高项目的逻辑结构合理性,对应扩展和合作,以及团队开发均有好处。 一个完整独立的PHP项目通常的文件和目录结构如下: / 项目根目录 /manage 后台管理文件存放目录 /css css文件存放目录 /doc 存放项目文档 /images 所有图片文件存放路径(在里面根据目录结构设立子目录) /scripts 客户端js脚本存放目录 /tpl 网站所有html的模版文件存放目录 /error.php 错误处理文件(可以定义到apache的错误处理中) 以上目录结构是通常的目录结构,根据具体应用的具体情况,可以考虑不用完全遵循,但是尽量做到规范化。 4.4.4 PHP和HTML代码的分离问题 对性能要求不是很高的项目和应用,我们建议不采用PHP和HTML代码直接混排的方式书写代码,而采用PHP和HTML代码分离的方式,即采用模版的方式处理,这样一方面对程序逻辑结构更加清晰有利,也有助于开发过程中人员的分工安排,同时还对日后项目的页面升级该版提供更多便利。 对于一些特殊情况,比如对性能要求很高的应用,可以不采用模版方式。 4.4.5 PHP项目开发中的程序逻辑结构 对于PHP项目开发,尽量采用OOP的思想开发,尤其在PHP5以后,对于面向对象的开发功能大大提高。 在PHP项目中,我们建议将独立的功能模块尽量写成函数调用,对应一整块业务逻辑,我们建议封装成类,既可以提高代码可读性,也可以提高代码重用性。比如,我们通常将对数据库的接口封装成数据库类,有利于平台的移植。 重复的代码要做成公共的库。(除了我们在plug-in产品上遇到的情况,该产品系列有多个相类似的产品,为了尽可能地减少安装包尺寸,不适合将这些产品共用的所有函数做成公共的库) 5 特定环境下PHP编码特殊规范 5.1 变量定义 XXX环境下的php代码编写要求所有的变量均需要先申明后使用,否则会有错误信息,对于数组,在使用一个不确定的key时,比如先进行isset()的判断,然后再使用;比如下面的代码: $array = array(); $var = isset($array[3]) ? $array[3] : “”; 5.2 引用的使用 引用在程序中使用比较多,为了公用同一个内存,而不需要另外进行复制,XXX环境下的引用使用时,需要注意下面的情况; 在对函数的输入参数中使用引用时,不能在调用的时候在输入参数前加&来引用,而直接使用该变量即可,同时必须在函数定义的时候说明输入参数来自引用,比如下面的代码: $a = 1; function ab(&$var) { $var ++; return $var; } $b = ab($a) // 注意,此处不能使用 $b = ab(&$a)的方式; echo $b.”\n”; echo $a.”\n”; 此时 $a和$b都是2; XXX环境下对引用的特殊要求源自php.ini文件里面的allow_call_time_pass_reference 项设置, 对外公开的版本是 On ,这样就可以支持&直接加到调用函数时变量前面进行引用,但是这一方法遭到抗议,并可能在将来版本的PHP/Zend里不再支持。受到鼓励的指定哪些参数按引用传递的方法是在函数声明里。你被鼓励尝试关闭这一选项(使用 off,XXX的所有运行环境下都是off)并确认你的脚本仍能正常工作,以保证在将来版本的语言里它们仍能工作。 5.3 变量的输入输出 在XXX环境下,对web通过GET或者POST方法传递来的参数均要求进行严格的过滤和合法性验证,不推荐使用直接的$_GET、$_POST或者$_REQUEST获取,而通过XXX的XXX_yiv模块提供的方法获取和过滤处理 规范完! 说明:规范中提到的XXX环境是特别指的xx曾经工作的XXX公司特定开发环境! |
2022-08-17
2022-11-06
2022-08-15
2022-08-18
2022-08-16
请发表评论