PHP语言规范文档.docx

1、PHP语言规范文档PHP语言编写规范第1章 命名规范1.1变量1。1.1全局变量全局变量使用g_开头，如$g_data_list.1.1。2 一般变量一般的变量使用小写字母命名,单词之间使用下划线分隔。变量名字应该使用名词或者形容词+名词的方式。如$value,$new_value。1。1.3 临时变量不要将在循环中频繁使用的临时变量如i,j等用于其它用途.1。2 函数函数采用小写字母命名，单词之间使用下划线分隔.函数的命名建议使用动词+名词的方式，如get_user_img。完成一组功能的函数放到一个文件中，存放函数的文件采用function_name.func.php命名.1.3 类类使用

2、英文的大小写来分隔单词,包括首个单词，所有单词的首字母大写，如PageManager；在类中，方法放到属性定义前边、公用方法放到专用方法前边;一般情况下，一个类对应到一个文件；当一些类关系紧密时，可以存放在一个文件中；存放类的文件采用ClassName。class。php方式命名。1.4 方法方法使用英文的大小写来分隔单词，除首个单词外，其他单词的首字母大写，如getCurrentPage（)；不要采用不常用的缩写，如where2go（）；使用常用的缩写时，只大写首字母，如getHtml()。第2章 版式规则2。1 语义分隔各个函数、方法之间应该采用空行间隔；同一个函数中联系紧密的语句之间可以

3、不换行，其他情况需要换行。2.2 空格规则2。2。1 逻辑运算符前后必须加空格正确 a = b；错误 a=$b；a =$b;备注 -正确 a+; $a；错误 a +; a ；备注 加一减一运算符不能加空格。2。2。2 多个参数分隔时必须加空格正确 $g_pro , g_user , g_show;get_db_info($host， $user, passwd）；错误 g_pro，g_user,g_show;get_db_info（$host，$user,passwd）；备注 2.2.3 语法关键字后必须加空格例如：If， for ， while, switch 。.正确 for （i = 0

4、; $i 10; i+)错误 for($i = 0; i 10; i+ )备注 -2.3 字符串和变量连接规则字符串与变量连接使用。号时,必须在。前后加空格，使用”号时,必须在变量前后加”。正确 $my_name = file_ 。 $var1；my_name = ”file_$var1；错误 $my_name = ”file_.var1;$my_name = ”file_var1;备注 -2.4 圆括号规则函数名后括号不需要加空格、语法关键字后的括号必须加空格。正确 for （i = 0； i 10; i+）strlen($my_name);错误 for($i = 0； i d5s。cn,

5、gender = php ）； /错误 array( name = , gender = php ）; ？2。7 SQL规则在PHP中嵌入的SQL语句关键字全部采用大写；表名和字段名要用反引号（)引起来以防止因为字段名中包含空格而出现错误；数据值两边用单引号”包括,并且应确保数据值中的单引号已经转义以防止SQL注入。正确 $sql = ”SELECT user。name FROM user WHERE id = $id LIMIT 1；错误 $sql = ”select name.user from name where id = id ”；备注 第3章 注释规则3。1 一般规则不写不必要的注

6、释；只有当代码不能很好地说明逻辑时，才用注释补充;把注释看成程序的一部分,在编写/维护代码时同时编写/维护注释；注释完全采用PHPDocumentor的规范，以方便用其生成API级文档。3。2 详细规则请参见PHPDocumentor手册.下边给出各个部分的注释示范。3.2.1 版权信息注释名称 版权信息注释示范 / +-+/ | phpDocumentor |/ +-+/ | Copyright (c） 2000-2003 Joshua Eichorn / Email jeichornphpdoc。org / Web http：/www。phpdoc。org |/ +-+/ This sou

7、rce file is subject to PHP License / +-+/备注 使用/来标示版权信息，以免和PHPDocumentor的pagelevel DocBlock发生冲突3.2。2文件头注释示例 注释名称 文件头注释注释示范 下载: php_doc。php ?php * All abstract representations of inline tags are in this file * package phpDocumentor * subpackage InlineTags * since separate file since version 1.2 versio

8、n Id $ / ？备注1 文件头注释需要指明所属的包和子包2 在version中加上ID，以方便使用CVS管理文件3.2。3 类注释示例注释名称 类注释注释示范 下载： php_class。php ?php /* * Use this element to represent an inline tag like link see parserStringWithInlineTags package phpDocumentor subpackage InlineTags author Greg Beaver 备注 -3。2.4 类属性注释示例注释名称 类属性注释注释示范 下载： php.ph

9、p ?php /* var $type = inlinetag； Element type * Type is used by many functions to skip the hassle of * * if get_class（blah） = parserBlah * /code * always inlinetag” var string */ ？备注 3.2.5 函数/类方法注释示例注释名称 函数/类方法注释注释示范 下载： php。php prop+）要比递增一个局部变量慢3倍。21、递增一个未预定义的局部变量要比递增一个预定义的局部变量慢9至10倍。22、仅定义一个局部变量而没

10、在函数中调用它，同样会减慢速度（其程度相当于递增一个局部变量）。PHP大概会检查看是否存在全局变量。23、方法调用看来与类中定义的方法的数量无关，因为我(在测试方法之前和之后都）添加了10个方法,但性能上没有变化。24、派生类中的方法运行起来要快于在基类中定义的同样的方法。25、调用带有一个参数的空函数，其花费的时间相当于执行7至8次的局部变量递增操作。类似的方法调用所花费的时间接近于15次的局部变量递增操作。26、Apache解析一个PHP脚本的时间要比解析一个静态HTML页面慢2至10倍。尽量多用静态HTML页面，少用脚本。27、除非脚本可以缓存，否则每次调用时都会重新编译一次。引入一套P

11、HP缓存机制通常可以提升25至100%的性能,以免除编译开销。28、尽量做缓存，可使用memcached。memcached是一款高性能的内存对象缓存系统，可用来加速动态Web应用程序，减轻数据库负载。对运算码 (OP code）的缓存很有用，使得脚本不必为每个请求做重新编译。29、当操作字符串并需要检验其长度是否满足某种要求时，你想当然地会使用strlen(）函数。此函数执行起来相当快,因为它不做任何计算，只返回在zval 结构(C的内置数据结构，用于存储PHP变量）中存储的已知字符串长度.但是，由于strlen（)是函数，多多少少会有些慢，因为函数调用会经过诸多步骤，如字母小写化（译注：指

12、函数名小写化,PHP不区分函数名大小写）、哈希查找,会跟随被调用的函数一起执行。在某些情况下，你可以使用isset(） 技巧加速执行你的代码。（举例如下）if (strlen($foo) 5) echo “Foo is too short （与下面的技巧做比较）if (！isset（$foo5) echo “Foo is too short” 调用isset（）恰巧比strlen（)快,因为与后者不同的是,isset()作为一种语言结构，意味着它的执行不需要函数查找和字母小写化。也就是说，实际上在检验字符串长度的顶层代码中你没有花太多开销。34、当执行变量$i的递增或递减时，i+会比+$i慢一

13、些。这种差异是PHP特有的,并不适用于其他语言，所以请不要修改你的C或Java代码并指望它们能立即变快，没用的。+$i更快是因为它只需要3条指令（opcodes），$i+则需要4条指令。后置递增实际上会产生一个临时变量，这个临时变量随后被递增。而前置递增直接在原值上递增。这是最优化处理的一种,正如Zend的PHP优化器所作的那样。牢记这个优化处理不失为一个好主意，因为并不是所有的指令优化器都会做同样的优化处理，并且存在大量没有装配指令优化器的互联网服务提供商（ISPs）和服务器。35、并不是事必面向对象（OOP)，面向对象往往开销很大，每个方法和对象调用都会消耗很多内存。36、并非要用类实现所

14、有的数据结构，数组也很有用。37、不要把方法细分得过多，仔细想想你真正打算重用的是哪些代码?38、当你需要时，你总能把代码分解成方法。39、尽量采用大量的PHP内置函数。40、如果在代码中存在大量耗时的函数，你可以考虑用C扩展的方式实现它们。41、评估检验(profile）你的代码。检验器会告诉你,代码的哪些部分消耗了多少时间。Xdebug调试器包含了检验程序，评估检验总体上可以显示出代码的瓶颈。42、mod_zip可作为Apache模块，用来即时压缩你的数据,并可让数据传输量降低80%.43、在可以用file_get_contents替代file、fopen、feof、fgets等系列方法的

15、情况下，尽量用file_get_contents，因为他的效率高得多！但是要注意file_get_contents在打开一个URL文件时候的PHP版本问题;44、尽量的少进行文件操作，虽然PHP的文件操作效率也不低的；45、优化Select SQL语句，在可能的情况下尽量少的进行Insert、Update操作（在update上,我被恶批过）；46、尽可能的使用PHP内部函数（但是我却为了找个PHP里面不存在的函数，浪费了本可以写出一个自定义函数的时间,经验问题啊！)；47、循环内部不要声明变量,尤其是大变量：对象（这好像不只是PHP里面要注意的问题吧?)；48、多维数组尽量不要循环嵌套赋值；49、在可以用PHP内部字符串操作函数的情况下，不要用正则表达式；50、foreach效率更高,尽量用foreach代替while和for循环；51、用单引号替代双引号引用字符串；52、“用i+=1代替i=i+1。符合c/c+的习惯，效率还高”；53、对global变量，应该用完就unset()掉；