命名規範

Table of Contents

• 1 命名規範
  • 1.1 造成行業命名規範
  • 1.2 實現客戶端和服務端的命名對接
  • 1.3 禁用中文拼音命名
  • 1.4 充分使用前綴，後綴的命名規範

1 命名規範

有人把代碼的不利於閱讀，歸結於註釋太少；可能這是一方面，可是好的命名，好的代碼排版更加使人賞心悅目；好的命名規範，根本不須要註釋來詮釋，看到命名就能「顧名思義」；再說了註釋密密麻麻的，看着就心煩；通常註釋應該放到邏輯比較複雜的地方。

1.1 造成行業命名規範

剛開始進入遊戲行業，策劃常常提到一些專有名詞，實在讓人弄不懂，什麼NPC啊，元寶啊俠客什麼的。後來百度才知道是怎麼回事，可是元寶這些詞在系統裏面對應什麼單詞，實在不知道。

若是一個新人不知，剛開始作系統，可能使用一些生僻的詞彙，不是項目組默許的，那就對於一個已經熟諳項目的人來講，變得不可理喻。原本默認元寶是gold，可能你就是money。原本默認俠客是ranger的，你卻用swordsman。

每一個行業都有本身的詞彙，將詞彙羅列出來，對新人培訓比較好，也花不了多長時間。

1.2 實現客戶端和服務端的命名對接

咱們系統是插件模型的，客戶端與服務端對稱的，客戶端作一個子模塊，服務端也作一個相同業務的子模塊。這期間涉及到消息的對接，雖然對接的消息ID是同樣的，可是我以爲還不夠好。消息的名稱、系統的名稱、變量、函數名稱也必須對接。

我經常遇到這樣的問題：抽獎，服務端用Draw，客戶端用Choujiang（原本用拼音就很差的）；再好比競技，服務端用Competitor，客戶端用Fighting之類的。

1.3 禁用中文拼音命名

好多人喜歡用拼音，認爲一個詞，根本就不知道其英文意思；其實咱們能夠用詞典，一查就知道了。

好比抽獎Draw，中文是Choujiang；至關於英文一個詞，中文兩個詞；並且中文尚未分割詞；而中文的拼音詞，通常首個字母大寫，即便兩個詞，也是連着的，通常用到人名，地名，好比Zhaojing Qu(有誰知道這三個漢字怎麼寫了)，前面是名，後面是姓了；Gugong，通常都會這樣。還有拼音的名稱，聲調有四種，容易混淆，並且拼音有時候不知道是那兩種漢字的組合，存在歧義。

用中文命名，首先是不夠簡潔，其次不是那麼一目瞭然。

1.4 充分使用前綴，後綴的命名規範

使用前綴或後綴可以對變量、類型和函數進行分類，這樣一眼就看出其真正的功能和用途。

好比類型命名：

AckXXX 回覆

MsgXXX 消息

MgrXXX 管理

ErrXXX 錯誤

好比變量命名：

p_xxx 指針

money_ 類成員變量

好比函數命名：

OnXXXX 消息

DoXXXX 處理消息的函數

GetXXX 獲取

SetXXX 設置