我的命名規範

之前經手過同僚的代碼，看到滿螢幕的不知所雲的變量名（比如abc），發音不标準的拼音（tanchang），感覺心情很沉重。

明明大家都是一個辦公室裡敲前端代碼的，為什麼你的代碼我看不懂。我還得問他，你這個abc是幹嘛的，這個tanchang是什麼。他回答tanchang我知道，是彈窗，這個abc嘛，我也忘了。

為了更好地讓自己代碼讓别人看懂，我參考了網絡上書本上常見的命名規範，特地制定了自己的命名規範。

可能的話，希望能在我們這個小辦公室裡推廣。

總則

• 格式化，一看就知道是哪一類：是樣式/變量/函數。

  一看，哦這個是樣式class名，這個是方法。

• 語義化，一看就知道大概是什麼。

  一看，哦這個是擷取使用者清單的，這個是處理資料結構的。

• 直白化，如果是拼音，禁用縮寫。如果用英文，避免查字典。

  用些進階詞彙還得查字典，寫的人查一遍字典，看的人查一遍字典，結果還都沒記住，下次還要查，還不如用拼音呢。

  提醒一下，用拼音的話，請使用标準國語，是biaozhun而不是biuzhun。

有人說用英文好，拼音有比較多的多音字，我反問一下，英文單詞難道就隻有一個意思嗎？miss,錯過？想念？小姐？

css樣式

• 元素的class名，id，使用中劃線-

.card-hd
#about-us
           

data變量

• 存放資料的變量，使用下劃線_

cur_page
is_show
           

• 數組直接加s

students,
products
           

不準偷懶，禁用list，list1這樣的變量。要語義化啊，代碼是寫給人看的

函數命名

• 函數命名使用小駝峰命名
• 函數參數使用下劃線_

getUsers(){},
cancelFollow(user_id){}
           

通過以上嚴格遵守規範，縱觀一眼代碼，我基本上就能知道裡面的一個單詞是哪一類，是什麼意思，是幹什麼的。

這樣一來，注釋也免了，代碼簡潔了，同僚也能看懂了，溝通起來就輕松了。啊，nice！