引言

良好的命名規(guī)范，可以提升代碼的整潔性、可讀性，對(duì)于項(xiàng)目后期的維護(hù)可以 更快的理解代碼的內(nèi)容。尤其在團(tuán)隊(duì)開(kāi)發(fā)中，大家采用約定方式去開(kāi)發(fā)代碼， 可以保證項(xiàng)目整體的可讀性提高協(xié)作效率。

術(shù)語(yǔ)解釋

• 小駝峰命名法
  變量一般用小駝峰法標(biāo)識(shí)。駝峰法的意思是：除第一個(gè)單詞之外，其他單詞首字母大寫
• 大駝峰命名法
  相比小駝峰法，大駝峰法把第一個(gè)單詞的首字母也大寫了。常用于類名，命名空間等
• 下劃線命名法
  如果一個(gè)變量或函數(shù)名字由一個(gè)或者多個(gè)單詞組成，用下劃線對(duì)不同的單詞進(jìn)行間隔，就形成下劃線命名法，單詞可以全部小寫，也可以全部大寫

規(guī)范內(nèi)容

• GameObject
  • Prefab
    采用 大駝峰 命名法，例如 HelloWorld
  • 資源文件
    • AssetBundle
      采用全小寫字母的 下劃線命名法 并且文件后綴名為 ab 例如 hello_world.ab， 因?yàn)樵赨nity中ab文件名是不能有大寫字母的
    • 其它文件
      采用全小寫字母的 下劃線命名法 和AB資源匹配，這樣保證所有的資源有統(tǒng)一的命名規(guī)則
• 類
  • 命名空間
    采用 大駝峰 命名法，例如 namespace HelloWorld 最好以模塊為單位來(lái)劃分命名空間
  • 類名
    采用 大駝峰 命名法, 并且類名和文件名相同， 例如 public class HelloWorld
  • 方法
    采用 大駝峰 命名法，例如 public static void HelloWorld()
  • 公共變量
    采用 小駝峰 命名法, 例如 public string helloWorld
  • 私有變量
    采用 小駝峰 命名法, 但是第一個(gè)字符以下劃線開(kāi)始， 例如 private string _helloWorld
  • 常量
    采用全大寫字母的 下劃線命名法 ，例如 public const int MAX_VALUE
  • 單例
    單例統(tǒng)一命名為 Ins 采用 get 封裝的拾取器，例如 HelloWorld.ins
• 全局
  • 變量
    采用 小駝峰 命名法, 例如 public static string helloWorld
  • 常量
    采用全大寫字母的 下劃線命名法 ，例如 public const int MAX_VALUE
  • 方法
    采用 大駝峰 命名法，例如 public static void HelloWorld()
• 框架約定
  • 數(shù)據(jù)結(jié)構(gòu)
    在變量名的結(jié)尾加上數(shù)據(jù)結(jié)構(gòu)的類型。如果我們的數(shù)據(jù)對(duì)象是List，那么我們?cè)诿@個(gè)變量的時(shí)候可以叫xxxList，例如我們有一個(gè)私有的好友列表屬性，那么可以叫 _friendList
  • 組件
    在變量名的開(kāi)頭加上組件名稱的縮寫。例如我們有一個(gè)負(fù)責(zé)登錄的Button組件，我們對(duì)它的公共引用變量就叫做 btnLogin，組件在「Inspector」中的名稱則采用 大駝峰 叫做 BtnLogin
  • 窗體
    窗體指的是在屏幕中可以出現(xiàn)多個(gè)的彈窗頁(yè)面，我們通常在名稱的結(jié)尾加上 Win 來(lái)對(duì)它進(jìn)行標(biāo)識(shí)，例如登錄窗口我們就叫 LoginWin
  • 舞臺(tái)
    舞臺(tái)指的是在屏幕中同一時(shí)間只會(huì)有一個(gè)的頁(yè)面，我們通常在名稱的結(jié)尾加上 Stage 來(lái)對(duì)它進(jìn)行標(biāo)識(shí)，例如游戲的大廳場(chǎng)景我們就叫 HallStage
  • 委托
    在委托的開(kāi)頭加上 On ，委托對(duì)應(yīng)的方法前也加上 On，例如 public delegate void OnHelloWorld()
  • 事件
    事件名稱以 Event 結(jié)尾，例如 HelloWorldEvent
  • 通知
    通知名稱以 Notice 結(jié)尾，例如 HelloWorldNotice
  • 數(shù)據(jù)對(duì)象
    游戲中我們通常定義的只有數(shù)據(jù)（不含任何業(yè)務(wù)邏輯）的結(jié)構(gòu)體，我們以 VO 結(jié)尾來(lái)標(biāo)識(shí)它，例如 HelloWorldVO