/**
 * [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 //品牌展示模版檔案