PHP编码规范

  • 2020-07-31 11:38:00
  • 阅读次数:
  • 作者:盈岚科技小编
  • 来源:http://www.lyjtt.cn

网站建设中的PHP编码规范

严谨的代码编写习惯将让用户受益终生,下面就PHP开发中一些约定俗成的编码规范进行汇总,以方便用户学习。

命名规范

  1. 变量

    •全局变量使用$g-开头,如$g-data-list。   

    •一般的变量使用小写字母命名,单词之间使用下划线分隔。   

    •变量名字应该使用名词或者形容词+名词的方式。如$value,$new-value。   

    •不要将在循环中频繁使用的临时变量等用于其他用途,如$i、$j。

  2. 常量常量使用大写字母命名,单词之间使用下划线分隔,如DB-HOST。

  3. 函数函数采用小写字母命名,单词之间使用下划线分隔。函数的命名建议使用动词+名词的方式,如get-user-img。

  4. 类类使用英文的大小写来分隔单词,包括首个单词,所有单词的首字母大写,如PageManager。在类中,方法放到属性定义前边,公用方法放到专用方法前边;一般情况下,一个类对应到一个文件;当一些类关系紧密时,可以存放在一个文件中;存放类的文件采用ClassName.class.php方式命名。

  5. 方法

    方法使用英文的大小写来分隔单词,除首个单词外,其他单词的首字母大写,如getCurrent-Page();不要采用不常用的缩写,如where2go();使用常用的缩写时,只大写首字母,如getHtml()。

版式规范

  1. 语义分隔各个函数、方法之间应该采用空行间隔;同一个函数中联系紧密的语句之间可以不换行,其他情况需要换行。

  2. 空格

    •逻辑运算符前后必须加空格,例如:$a == $b;        //正确$a==$b,$a ==$b; //错误$a++; $a–;       //正确$a ++; $a  –;    //错误

    •加减运算符不能加空格。   

    •多个参数分隔时必须加空格,例如:$g_pro, $g_user, g_show;            //正确get_db_info($host, $user, $passwd); //正确$g_pro,$g_user,$g_show;             //错误get_db_info($host,$user,$passwd);   //错误   

    •语法关键字后必须加空格,例如:for($i = 0; $i < 10; $i++)    //正确for($i = 0; $i < 10; $i++ )   //错误

  3. 字符串和变量连接字符串与变量连接使用‘.’号时,必须在‘.’前后加空格,使用“”号时,必须在变量前后加“{}”。

    例如:$my_name =  ‘file_’  . $var1;   //正确$my_name =  “file_{$var1}”;     //正确$my_name =  ‘file_’.$var1;      //错误$my_name =  “file_$var1”;       //错误

  4. 圆括号函数名后括号不需要加空格,语法关键字后的括号必须加空格。例如:for ($i = 0; $i < 10; $i++) //正确strlen($my_name);           //正确for($i = 0; $i < 10; $i++ ) //错误strlen ($my_name);          //错误

  5. 花括号花括号必须为上下对应。例如,下面写法是正确的。if ($a) {    $b = $a;}

  6. 数组定义数组定义和使用时在key值前后必须加单引号。例如:   

    •正确

    array(    'name' => 'd5s.cn',    'gender' => 'php');   

    •错误

    array(    name => 'd5s.cn',    gender => 'php');

  7.  SQL字符串

    在PHP中嵌入的SQL语句关键字全部采用大写;表名和字段名要用反引号(`)引起来以防止因为字段名中包含空格而出现错误;数据值两边用单引号'包括,并且应确保数据值中的单引号已经转义,以防止SQL注入。

    例如:$sql = “SELECT `user`.`name` FROM `user` WHERE `id` = ‘$id’”;  //正确$sql = “select name.user from name where id = $id”;         //错误

当前文章标题:PHP编码规范

当前URL:http://www.lyjtt.cn/news/wzzz/3251.html

上一篇:PHP类和对象(2)

下一篇:注释规范

网站建设、抖音推广、头条推广、微信朋友圈推广、快手推广专线:181-8386-5875(微信同号)