天天看點

命名規則一、變量命名二、方法函數命名三、類命名四、一些命名約定

一、變量命名

1、普通變量

  • 變量中的所有字母字元均為小寫
//例
	$username = 'Jim Green';
	//反例
	$userNAME = 'Li Lei';
           
  • 變量命中隻能出現字母和下劃線和必要時的數字(變量中除非十分必要時可出現數字,否則不建議在命名中使用數字)
//例
	 $name_wang = 'Mr . wang';
	 $name_zhang= 'Mr . zhang';
	 //反例
	 $name1 = 'Mr . wang';
	 $name2 = 'Mr . zhang';
           
  • 變量以字母開頭,不能以下劃線和數字開頭,也不能以下劃線結尾
  • 變量中禁止出現拼音和英文單詞的組合,更不允許出現漢字,不推薦拼音來命名
//例
	  $goods_redwine = '紅酒';
	  //反例
	  $goods_hongjiu = '紅酒';
           
  • 變量名盡量不使用縮寫,或者使用通用的、公認的縮寫
  • 變量名要達到望文生義的效果

2、常量

  • 常量名全部大寫,要求語義明确,不局限于變量名稱的長度,各單詞之間用下劃線連接配接
define('MESSAGE', 'Welcome to earth !');
	define('FIRST_MESSAGE', 'Hello World !');
           
  • 常量名要達到望文生義的效果
  • 常量名中隻能出現大寫字母和下劃線 ,杜絕出現數字
  • 下劃線隻用來作連接配接作用,不出現在變量名來頭和結尾

3、成員變量

  • 成員變量名以小寫字母開頭,成員變量名由多個單詞組成時,除第一個單詞首字母小寫,其他單詞首字母大寫然後連接配接(小駝峰命名)
  • 杜絕出現除字母之外的其他符号,不推薦在成員變量中使用數字
  • 成員變量名要達到望文生義的效果

4、參數名

  • 方法函數的參數名以小寫字母開頭,由多個單詞組成時,除第一個單詞首字母小寫,其他單詞首字母大寫然後連接配接(小駝峰命名)
  • 杜絕出現除字母之外的其他符号,不推薦在參數名中使用數字
  • 參數名要達到望文生義的效果

二、方法函數命名

  • 方法函數名以小寫字母開頭,方法函數名由多個單詞組成時,除第一個單詞首字母小寫,其他單詞首字母大寫然後連接配接(小駝峰命名)
  • 方法函數名中禁止出現拼音和英文單詞的組合,更不允許出現漢字,不推薦拼音來命名
  • 杜絕出現除字母之外的其他符号,不推薦在方法函數名中使用數字
  • 方法函數名要淺顯易懂,達到望文生義的效果

三、類命名

  • 類名以大寫字母開頭,類名由多個單詞組成時,各單詞首字母大寫然後連接配接(大駝峰命名)
  • 類名中禁止出現拼音和英文單詞的組合,更不允許出現漢字,不推薦拼音來命名
  • 杜絕出現除字母之外的其他符号,不推薦在類名中使用數字
  • 類名要淺顯易懂,達到望文生義的效果

四、一些命名約定

1、變量名

  • bool型的标志或者狀态通常在命名中添加 _flag 或 _status 字尾
  • 數組使用 _arr 字尾名或者使用 名詞複數形式
  • 從資料庫查詢到的資料集合通常使用 moduleName + _list / _data / _arr 約定來命名

2、方法名

  • 更新方法使用 update 字首
  • 删除方法使用 remove 或者 delete 字首
  • 插入方法使用 save 或者 insert 字首
  • 擷取單個資料方法使用 get 字首
  • 擷取多個資料方法使用 list 字首
  • 統計方法使用 count 字首
  • 判斷方法使用 is 字首

3、類名、接口名

  • 抽象類使用 Abstract 字首
  • 異常類使用 Exception 字尾
  • 測試類使用要 測試類的類名 + Test字尾