我的命名规范

之前经手过同事的代码，看到满屏幕的不知所云的变量名（比如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！