首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

团队合作开发,一定要有规范,谈JS代码的规范怎么搞

由于写JavaScript代码,还算是比较随意的,相对来说, 对开发者的限制就少很多,例如我们不用像写C语言一样每行必须换行符,这样,很多人在开发时都有自己的习惯,包括命名习惯,代码书写习惯等等。然而,这种随意也带来一个坏处,就是团队合作开发时,代码风格不统一,所以,搞前端的,团队开发时,一定要制定代码规范。

第一,这样的好处至少有以下几点

1、提升代码阅读效率

无论拿到谁的代码,都感觉就像自己写的。代码很工整,阅读起来神清气爽,酣畅淋漓。例如:有的团队规范指定变量使用驼峰命名,类命名也使用驼峰,但是第一个字母大写。这样我们只要一看到变量,就知道它是变量还是类。不用去寻找代码定义的地方了。

2、减少BUG数,提高代码质量

通过规范的规则,我们可以做到很多事。例如:强制使用===做判断,检查未定义的变量,声明的变量未使用等等。这些看起来不起眼的规则其实很可能就是隐藏的bug,而且有可能是最容易被忽略的,也就是最难debug到的。

3、对个人的成长非常有利

团队代码规范一般是团队总结出来的或者业界比较认可的,是大家多年经验的结晶。

对于个人来说,遵循这些代码规范,会养成一个比较好的习惯。虽然刚开始遵循这些规范会很不适应,但是一旦习惯后,就变得像强迫症一样,写代码时会不自觉遵守。

第二,现在我来举一个很简单的例子

这个例子就是switch定义

Switch 是各编程语言必有的保留字,谷歌公司的代码规范中提及“每个 case 要么通过 break/return 等来终止,要么注释说明程序将继续执行到哪一个 case 为止”。为什么会有这样的约束?因为这样可以比较清楚地表达程序员的意图,有效防止无故遗漏的 break 语句。如下图所示:

上述示例中,每当一个 case 顺着往下执行时(因为没有 break 语句),通常应在 break 语句的位置添加注释。上面的示例代码中就包含了注释“/* 程序继续执行直到 DEF 分支 */”(这一条也是 SUN 公司 1997 年代码规范的要求)。

语法上来说,default 语句中的 break 是多余的,但是如果后续添加额外的 case,可以避免找不到匹配 case 项的错误。

第三,给大家推荐两个好的规范

牛逼的团队一般是有自己的代码规范的,说实话,搞一个代码规范是一件很难的事, 加上,如果结合ESLint来检测代码的话,最好还是做成插件来用,这样就更加麻烦了,这里我推荐两个常用的代码风格规范。只要通过简单配置就可以。

1、JavaScript Standard Style(https://standardjs.com/)

详细可以到官网去看一看。

2、airbnb-javascript(https://github.com/airbnb/javascript)

这个规范包含推荐的es5以及es6,react的代码规范,并且基本上都有相应的错误和正确代码以及为什么要这么写,个人觉得有时间去读一读还是很好的,虽然感觉有些规则也不是很赞同。

最后总结一下:

1、首先我推荐两规范是比较流行的,但不一定是最好的。

2、JavaScript仍然会快速发展,开发中最重要的也就是质量和效率。过度遵循代码规范,追求代码严谨也许并不能带来预期的好处。所以做到怎样的程度还是需要大家自己拿捏的。

  • 发表于:
  • 原文链接http://kuaibao.qq.com/s/20180326A1SYG400?refer=cp_1026
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群
领券