PHP个人常用简单命名规范以及搜集的相关命名规范

/**
 * [1、超过三个单词组成的混合类名是容易造成系统各个实体间的混淆，请重新设计类名]
 * [2、实际开发中，命名方式一般有以下几种情况 ]
 * 大驼峰法：每个单词首字母大写                           例如：BadCode
 * 小驼峰法：除第一个单词之外，其他单词首字母大写          例如：adminChangeCode //个人常用
 * 帕斯卡法: 除首字母大写，其他小写                       例如：Badcode
 * 下划线法：函数名中的每一个逻辑断点都有一个下划线来标记   例如：print_goods_list //最好都小写
 */

                                        /************（个人）基本命名规范************/

#文件开头注释

/*
 +-------------------------------------------------------------------------------------------
 + Title        : 文件开头标题
 + Version      : V1.0.0.2
 + Initial-Time : 2017-07-20 + sgw
 + Last-time    : 2017-12-22
 + Desc         : 只是一个自己常用命名规范，以及搜集的一些命名规范，为了使代码便于以后的阅读
 +-------------------------------------------------------------------------------------------
*/

# 方法注释

/**
 * 方法描述
 * @Initial-Time  : 2017/12/22 + sgw
 * @param  [type] $foo  [Desc]
 * @param  [type] $foo1 [Desc]
 * @return [type] $foo2 [Desc]
 * Log  :  描述修改记录 2017-12-22 sgw
 */

#文件名使用英文名词、英文动词，以及下划线，所有字母都使用小写字母。
index.php
index_ad.html

#大驼峰法，常用于类名定义
class Book{ }
class RedBook{ }

#小驼峰法，常用于方法名定义
class Book{
    public function getName(){ }
}

#下划线，常用于变量名定义
$foo_color = 'red'; 
$foo_get_way = 'play';

                                /*********（搜集）以下附带一些基本的命名规范******/

一、变量命名

#（1）使用英文名词、动词，以大写字母作为单词的分隔，其他的字母均使用小写，单词的首个字母使用小写,例如：
$repeatCount = '';
$delUserSql = '';

#（2）变量命名如要用缩写，只能使用项目中有据可查的英文缩写方式，例如可以使用$data而不可使用$data1、$data2这样容易产生混淆的形式，应当使用$articleData、$userData这样一目了然容易理解的形式。

#（3）除非特殊情况，一般不推荐使用下划线,例如:
$repeat_count = '';//不推荐

二、数组变量命名

#使用英文名词、动词，以大写字母作为单词的分隔，其他的字母均使用小写，单词的首个字母使用小写，不使用下划线，以字符串 Array 为后缀,例如:
$scopeArray = array(); $bookIdArray = array();
//[提示]  除非特殊情况，一般不推荐使用下划线。
如：$book_id_array = array();//不推荐

三、静态变量

#第一种写法：静态变量应该带前缀‘s’，使用大写字母作为词的分隔，其他的字母均使用小写。理由：知道一个变量的作用域是非常重要的,例如：
        function test(){
            static $sStatus = 0;
        }

#第二种写法：使用英文名词、动词，以大写字母作为单词的分隔，其他的字母均使用小写，单词的首个字母使用小写，不使用下划线，以字符串 Static 为后缀,例如:
function getDirectoryFile(){
    static $fileArrayStatic = '';
    static $fileNumStatic = '';
    ...
}
function getDirectoryFile(){
    static $fileArrayStatic = '';
    static $fileNumStatic   = '';
    ...
}

四、函数命名

#函数名使用小写字母、下划线组合。如：get_client_ip() 函数名字采用C语言的惯例，所有的字母使用小写字母，使用'_'分割单词。 这样可以更易于区分相关联的类名。
//注意点1：不要把小括号和函数名紧贴在一起。 要用空格隔开它们。 如果小括号紧贴着函数名，二者很容易被看成是一体的，例如：
  function some_bloody_function () {
      ...
  }
//注意点2：除非必要，不要在Return返回语句中使用小括号。

五、类属性命名规范

#使用英文名词、动词，以大写字母作为词的分隔，其他的字母均使用小写，对于类属性为某个对象变量，则以字符串 Object 为后缀，普通属性命名规范同变量的命名规范。如果是用于存储对象的属性，使用1个下划线开始，例如：
public $tableName = '';
private $databaseObject = '';
public  $_username = NULL;

六、类的实例对象的命名（对象变量命名）

#类的实例对象的命名规范同变量的命名规范，只不过实例对象是以1个下划线开头的，同类中存储对象的属性的规范一样。这样，无论是在类的内部，还是类的外部，只要是以下划线开头的变量，那就是对象名。（jQuery对象的命名规范与此一致。国外通用。），例如：
$_name = new UserName();
#有的公司要求是 "变量名" + "_obj"，如：$name_obj; 而有的公司则使用类名称为变量前缀，所有字母都使用大写，以字符串_OBJECT 为后缀，例如：
$USERNAME_OBJECT = new UserName();
$PAINTINGORDER_OBJECT = new PaintingOrder();

七、数据库命名

#数据库表名所有字母都使用小写，使用'_'作为每个词的分界,数据字段命名也与数据表命名相同，例如：
cz_goods_attr //商品属性表
cz_goods_type //商品类别表

八、模板文件名命名

#所有字母都使用小写，使用'_'作为每个词的分界，这样做的好处是方便平移到其他的系统平台中,不会因为大小写而发生问题，例如：
brand_add.html //品牌增加显示模版文件
brand_list.html //品牌展示模版文件