我的命名规范

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,616评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,020评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,078评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,040评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,154评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,265评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,298评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,072评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,491评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,795评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,970评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,654评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,272评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,985评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,815评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,852评论 2 351

推荐阅读更多精彩内容