PHP项目 编码规范 - RPENG

一、注释

  1、文件注释    只写了必要格式，其他注释自行添加即可

         行1  ：功能描述

         行2  ：作者 

如下 

// +----------------------------------------------------------------------
// | 功能：会员管理控制器
// +----------------------------------------------------------------------
// | Copyright (c) 蓝天工作室
// +----------------------------------------------------------------------
// | Licensed ( http://www.biglamp.cn )
// +----------------------------------------------------------------------
// | Author: RpengWang < 602663099@qq.com >
// +----------------------------------------------------------------------

2、方法注释    

     行1：功能描述，如果功能较多，可写多行

     行2：参数说明，说明参数的类型和解释

     行3： 返回值说明  如果有多个返回，必须依次标明

     行4：作者

     行6：时间，如果二次修改，也必须写明修改人和时间

如下 

/**
     * 前置操作
     * @access protected
     * @param  string $method  前置操作方法名
     * @param  array  $options 调用参数 ['only'=>[...]] 或者 ['except'=>[...]]
     * @return void
     * @author RpengWang 
     * @time  2018-11-12
     */

3、单行注释   注释写在代码上一行，不能写在代码同行后

这是正确写法     一行注释，一行代码



// 返回当前模型的数据库查询对象
        return $query;




这是错误写法，注释和代码写在一行
$age = 18;    //年龄

4、多行注释 

/*//
*注释第一行
*注释第二行
*注释第三行
*注释第四行
//*/

二、命名规范

文件名采用大驼峰规则

方法命名采用大驼峰规则

变量命名多个单词 用 "_" 下划线，不可采用缩写

常量一律大写

配置一律大写

三、编码要求

一级：功能完整

二级：数据安全

三级：扩展性强，执行效率高

四级：代码易维护，易读懂