php 编程规范

sdtf08

　　第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类
类使用英文的大小写来分隔单词，包括首个单词，所有单词的首字母大写，如PageManager；
在类中，方法放到属性定义前边、公用方法放到专用方法前边；
一般情况下，一个类对应到一个文件；
当一些类关系紧密时，可以存放在一个文件中；
存放类的文件采用ClassName.class.php方式命名。
　　1.4方法
方法使用英文的大小写来分隔单词，除首个单词外，其他单词的首字母大写，如getCurrentPage()；
不要采用不常用的缩写，如where2go()；
使用常用的缩写时，只大写首字母，如getHtml()。
　　第2章版式规则
　　2.1语义分隔
各个函数、方法之间应该采用空行间隔；
同一个函数中联系紧密的语句之间可以不换行，其他情况需要换行。
　　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;$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<10;$i++)
strlen($my_name);
备注-
　　2.5花括号规则
花括号必须为上下对应。
　　正确
if($a)
{
$b=$a;
}
　　错误if($a){
$b=$a;
}
　　备注-
　　2.6数组定义规则
　　数组定义和使用时中key值前后必须加单引号。
　　PHP代码:
　　下载:php_array.php
　　1<?php
　　2//正确
　　3array(
　　4'name'=>'d5s.cn',
　　5'gender'=>'php'
　　6);
　　7//错误
　　8array(
　　9name=>'d5s.cn',
　　10gender=>'php'
　　11);
　　12?>
　　
2.7SQL规则
　　在PHP中嵌入的SQL语句关键字全部采用大写；
表名和字段名要用反引号(`)引起来以防止因为字段名中包含空格而出现错误；
数据值两边用单引号”包括，并且应确保数据值中的单引号已经转义以防止SQL注入。
　　正确$sql=”SELECT`user`.`name`FROM`user`WHERE`id`=’$id’LIMIT1″;
错误$sql=”selectname.userfromnamewhereid=$id”;
备注-
　　第3章注释规则
　　3.1一般规则
不写不必要的注释；只有当代码不能很好地说明逻辑时，才用注释补充；
把注释看成程序的一部分，在编写/维护代码时同时编写/维护注释；
注释完全采用PHPDocumentor的规范，以方便用其生成API级文档。
　　3.2详细规则
请参见PHPDocumentor手册。下边给出各个部分的注释示范。
　　3.2.1版权信息
注释名称版权信息
注释示范//
//+—————————————————-+
//|phpDocumentor|
//+—————————————————-+
//|Copyright(c)2000-2003JoshuaEichorn|
//|Emailjeichorn@phpdoc.org|
//|Webhttp://www.phpdoc.org|
//+—————————————————-+
//|ThissourcefileissubjecttoPHPLicense|
//+—————————————————-+
//
备注使用//来标示版权信息，以免和PHPDocumentor的page-levelDocBlock发生冲突
　　3.2.2文件头注释示例
　　注释名称文件头注释
注释示范
　　下载:php_doc.php
　　13<?php
　　14*Allabstractrepresentationsofinlinetagsareinthisfile
　　15*@packagephpDocumentor
　　16*@subpackageInlineTags
　　17*@sinceseparatefilesinceversion1.2
　　18*@version$Id$
　　19*/
　　20?>
　　备注
1文件头注释需要指明所属的包和子包
2在@version中加上$ID，以方便使用CVS管理文件
　　3.2.3类注释示例
注释名称类注释
注释示范
　　下载:php_class.php
　　21<?php
　　22/**
　　23*Usethiselementtorepresentan{@}inlinetag}like{@}link}
　　24*@seeparserStringWithInlineTags
　　25*@packagephpDocumentor
　　26*@subpackageInlineTags
　　27*@authorGregBeaver<cellog@users.sourceforge.net></cellog@users.sourceforge.net>
　　28*@since1.0rc1
　　29*@version$Revision:1.21.2.6$
　　30*@tutorialinlinetags.pkg
　　31*/
　　32?>
　　备注-
　　3.2.4类属性注释示例
注释名称类属性注释
注释示范
　　下载:php.php
　　33<?php
　　34/**var$type='inlinetag';
　　35*Elementtype
　　36*
　　37*Typeisusedbymanyfunctionstoskipthehassleof
　　38*
　　39*<code>
　　40*ifget_class($blah)=='parserBlah'
　　41*</code>
　　42*always"inlinetag"
　　43*@varstring
　　44*/
　　45?>
　　备注-
　　3.2.5函数/类方法注释示例
注释名称函数/类方法注释
注释示范
　　下载:php.php
　　46<?php
　　47/**functiongetString()'';
　　48*@returnstringalways''
　　49*calculatetheshortdescriptionofaDocBlock
　　50*@seeparserStringWithInlineTags::getString()
　　51*@seeparserStringWithInlineTags::trimmedStrlen()
　　52*/
　　53
　　54{
　　55return
　　56}
　　57?>