PHP代码编写规范.doc

《PHP代码编写规范.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、PHP代码编写规范一、编辑器设置（1）使用Tab缩进，不要使用空格鉴于很多编辑器在保存文件时会自动清除用于缩进的空格，所以我们一律使用Tab键进行缩进。（2）UNIN文件格式请将编辑器设置对所有程序使用UNIX格式保存，不要使用Win32或者Mac的格式。例如，EditPlus里面Document->FileFormat(CR/LF)->Unix。对于windows格式文件，以Ctrl+M结束（vim下为^M）,需要过滤掉：$text=strtr($text,"x0D","");二、命名设置1、公共库名称空间TPL

2、IB，TencentPHPLibrary2、变量命名（1）所有字母都使用小写（2）首字母根据变量值类型指定整数I、浮点数f、字符串s、布尔值b、数组a、对象o、资源r、混合类型m（3）使用’_’作为每一个词的分界例如：$i_age_max=10;$f_price=22.5;$s_name=‘harry’;$b_flag=true;$a_price=array();$o_object=newclass();$r_file=fopen();$m_var=array_combine($a_name,$a_flag); 3、

3、类命名（1）使用大写字母作为词的分隔，其他的字母均使用小写，即驼峰格式。（2）名字的首字母使用大写（3）不要使用下划线(’_')（4）interface接口最好使用大写字母I,并以Interface结尾例如：classNameOneTwoclassNameinterfaceIExampleInterface()4、方法命名（1）使用大写字母作为词的分隔，其他的字母均使用小写（2）名字的首字母使用大写,声明为“private”或“protected”的，使用’_’为前缀（3）不要使用下划线(’_')（4）与类命名一致的

4、规则（5）对象的访问器总是以“get”或“set”为前缀，当使用设计模式如单态模式（singleton）或工厂模式（factory），方法的名字应当包含模式的名字，这样容易从名字识别设计模式。例如：classNameOneTwo{publicfunctionDoIt(){};protectfunction_HandleError(){};privatefunction_SayHello(){};}5、类属性命名（1）属性名前缀应以属性值类型指定（具体参照变量命名规则）（2）前缀后采用与类命名一致的规则（3）私有属性采

5、用’_’为前缀例如：classNameOneTwo{publicfunctionVarAbc(){};publicfunctionErrorNumber(){};public$iAge;private$_iAge;}6、方法中参数命名（1）参照类属性命名例如：classNameOneTwo{publicfunctionVarAbc($sMsg){};}7、全局变量（1）全局变量应该带前缀‘g’（2）其余参照变量命名规则例如：global$gi_Age;global$ga_Price8、定义命名/全局常量（1）全局常量

6、使用’_’分割每个单词（2）所有字母使用大写例如：define(‘E_ERROR_MISSING_PARA’,501);9、函数（1）所有的字母采用小写，使用’_’分割每个单词例如：functionsome_bloody_function(){}10、文件命名包含文件应该以.inc.php方式命名，例如config.inc.php。单独类的文件使用Classname.php方式命名，包中的类使用PackageName/ClassName.php命名。三、代码层1、大括号{}规则（1）将大括号放置关键词下方的同列处或同

7、行，推荐放到同行例如：functionsome_bloody_function(){}if(true){//code}2、缩进/制表符规则（1）使用制表符缩进例如：functionsome_bloody_function(){if(true){//code}}3、小括号、关键词和函数规则（1）不要把小括号和关键词紧贴在一起，要用空格隔开它们（2）小括号和函数名要紧贴在一起（3）除非必要，不要在Return返回语句中使用小括号例如：if(condition){}strcmp($sHello,$sEvening);ret

8、urn1;4、IfThenElse格式布局if(条件1){//注释}elseif(条件2){//注释}else{//注释}如果你有用到elseif语句的话，通常最好有一个else块以用于处理未处理到的其他情况。可以的话放一个记录信息注释在else处，即使在else没有任何的动作。条件格式总是将恒量放在等号/不等号的左边，例如：if(6==$er