搜索
PHP编程规范良好的代码书写习惯+良好的注释习惯+PhpDocumentor=程序说明书一个团队，必须有整齐的代码书写习惯，如果再配上统一的IDE开发环境，详细的任务编码流程，完善的代码测试，那么整个团队的开发效率将会有很大的提高。第1章命名规范全局变量使用全大写形式，如$FILE_ROOT、$URL_ROOT。一般变量使用小写字母命名，单词之间使用下划线分隔。变量名字应该使用名词或者形容词+名词的方式。如$value，$new_value。数组名字使用名词+Arr的方式，如$infoArr。1.1临时变量不要将在循环中频繁使用的临时变量如$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;$i10;$i++)错误for($i=0;$i10;$i++)2.3字符串和变量连接规则字符串与变量连接使用’.'号时，必须在’.'前后加空格，使用”号时，必须在变量前后加”{}”。正确$my_name=‘file_’.$var1;$my_name=”file_{$var1}”;错误$my_name=‘file_’.$var1;$my_name=”file_$var1”;2.4圆括号规则函数名后括号不需要加空格、语法关键字后的括号必须加空格。正确for($i=0;$i10;$i++)strlen($my_name);错误for($i=0;$i10;$i++)strlen($my_name);2.5花括号规则花括号统一按以下方式写：if($a){$b=$a;}2.6数据库规范在PHP中嵌入的SQL语句关键字全部采用大写；数据值两边用单引号包括，并且应确保数据值中的单引号已经转义以防止SQL注入。正确$sql=”SELECTuno,nameFROMuser_blogWHEREid=‘$id’LIMIT1”;错误$sql=”selectuno,namefromuser_blogwhereid=$id”;数据表以zqt_作为前缀，例如zqt_mobile字段名全为小写，以下划线分隔单词建表时注明备注，方便理解字段用处如需对数据表结构进行更改，需提交申请资料，统一由技术负责人更改。第3章注释规则3.1一般规则不写不必要的注释；只有当代码不能很好地说明逻辑时，才用注释补充；把注释看成程序的一部分，在编写/维护代码时同时编写/维护注释；3.2文件头注释注释示范/******文件名:lib.php*功能描述:网站公用文件*作者:jake*日期:2009-11-3*****/3.3函数/类方法注释示例注释示范/*****functiongetString();*功能：calculatetheshortdescriptionofaDocBlock*返回值：returnstringalways*实例：$val=getString(123)****/3.4二次开发注释二次开发时，为了以后维护方便，尽量把注释写详细，尽量不要删除原有程序代码，需要时可以加上/**/注释掉。增加的文件加上文件头注释增加代码注释示范：//beginmodifybyjake20100707代码段//endmodifybyjake20100707修改代码注释示范：//beginaddbyjake20100707代码段//endaddbyjake20100707