PHP开发规范

版权声明:廖圣平博客,未经博主允许不得转载。企鹅:1194008361 https://blog.csdn.net/qq_22823581/article/details/87689797

文档目的

本规范希望通过制定一系列规范化PHP代码的规则,统一风格,便于代码阅读,提高效率。
文档适用范围
适用于所有PHP开发人员

编码规范

源文件

PHP代码文件必须以不带BOM的UTF-8编码; 纯PHP文件必须省略最后 ?>结束标签。

缩进

使用tab键来缩进,每个tab键长度必须设置4个空格。

每行最多120个字符;非空行不能有多余的空格;每行不能有多条语句;
适当空行有利于代码阅读,但不能滥用。
关键字

PHP所有关键字必须小写,bool值true,false,null 也必须小写;
关键字有:abstract、array、as、break、case、catch、class、const、try、use、public等等。
函数

每个函数或方法不能多于60行。
数组

当有两个以上键值对时,请换行,如:

$where = [
    'id' => 789,
    'user_name' => '52php'
];

命名
1、 类名 类名使用大驼峰式的写法,如下:

class ClassName
{
    // constants, properties, methods
}

2、 类的方法名 类方法名使用小驼峰的写法,方法名紧跟括号,中间不能有空格,参数之间要有空格且大括号必须自成一行如下:

class ClassName
{
    public function fooBarBaz($storeName, $storeId, array $info = [])
    {
        // method body
    }
}

3、 类文件名 类文件名必须和对应的类名一致,也是大驼峰式写法
4、其他文件名 如视图、配置、脚本文件等全部用小写字母+下划线命名
5、 函数名 普通函数使用小写字母+下划线命名,且函数名紧跟括号,中间不能有空格,参数之间要有空格,大括号换行如:

function curl_request($a, $b)
{
     // method body
}

6、 变量、常量名 变量名使用小驼峰的写法,常量名全部用大写+下划线,如下

//变量
$userName = 'xia';
//常量
const  VERSION = '1.0';
const  SITE_URL = 'http://www.baidu.com';

7、数据库命名

数据库全部用小写命名,数据表及字段采用小写+下划线方式命名,且表中主键id尽可能加上表名,如:title_id。
注释

类、方法、行数,要以/* */格式注释,第二行开始写注释内容,表明作者、时间、参数格式、返回格式等,常用标签有:@autor、@since、@param 、@return等,如:

/**
 * 我是类描述信息哦!
 * 
 * @author  Author
 * @since   2015.01.02
 * @version 1.0
 */
class ClassName
{
    public function aVeryLongMethodName(
        ClassTypeHint $arg1,
        &$arg2,
        array $arg3 = []) 
    {
        // method body
    }
}

/**
 * 我是方法描述信息
 *
 * @author Author
 * @since  2015.01.02
 * @param ClassName $arg1 参数1描述 我是具体的对象类型哦
 * @param array $arg2 参数2描述 我是数据类型哦
 * @param int $arg3 参数3描述  我是基本数据类型哦
 * @return boolean
 
 */
 public function methodName(ClassName $arg1, array $arg2, $arg3) 
 {
    // method body
    return true; 
 }

其他注释 尽量用 //,注释开始前必须一个空格
控制结构

控制结构关键词(if、elseif、else、foreach、switch、case、try、catch、for等)后必须有一个空格;
左括号 ( 后一定不能有空格,右括号 ) 前也一定不能有空格;
右括号 ) 与开始花括号 { 间一定有一个空格;
结束花括号 } 一定在结构体主体后单独成行。

if ($expr1) {
   // if body
 } elseif ($expr2) {
   // elseif body
 } else {
   // else body;
 }

在 if 条件判断中,如果用到常量,将常量放在等号或不等号的左边,如下:

if (6 == $a) {
  //body
}

当大于两个 if 时,请使用 switch 代替 if,如:

<?php
switch ($expr) {
    case 0:
        echo 'First case, with a break';
        break;
    case 1:
        echo 'Second case, which falls through';
        break;
    case 2:
    case 3:
    case 4:
        echo 'Third case, return instead of break';
        break;
    default:
        echo 'Default case';
}

没有更多推荐了,返回首页