如何写出优雅的Javascript代码

笔者以前写Javascript的时候,经常会把代码写的又臭又长又啰嗦。

在经过一段实践的实践和反思后,代码的优雅性应该提高很多。
所以个人就总结了写出优雅Javascript代码的心得。

不写分号

不写分号能显著让代码更加优雅,并少轻松你的双手。
可能很多人会有疑问,没有分号的Javascript也能正常运行?
几乎是的。不过在一些特殊的时候Javascript引擎并不会帮助你正确插入分号。
具体的情况只有这五个符号:+-([/
没了。
也就是说,凡是新的一行代码以上述五个符号开头,那么之前一句的末尾是需要分号的。
而在实际情况中,以+,- 开头的新一行代码几乎不可能出现。
所以可能情况:

(function(){
  // do something
})()

如果之前没加分号,那么这个匿名函数外的括号会调用上一行定义的函数,匿名函数就变成了参数。记住下面的这个分号

;(function(){
  // do something
})()

还有比如这样

;(a == 1 || b == 1) && fn()

;[].slice.call()

;/abc/.test('abcd')

除了上面例子,几乎没有其他情景需要加分号了。
所以经常遇到这种情况,一个javascript文件里几百个分号全是没必要的。
而且,通常在生产环境中会提前用uglify.js去压缩代码,或是用ES6时babel转码,这都会帮你补全分号。
所以还有什么理由去写分号呢?
当然写不写分号也属于个人习惯,知道什么时候分号是不可省的才是重点。
PS:Vue.js的源码就是不写分号的。

使用ES6

相比较ES5,ES6的语法中的结构赋值,箭头函数,模板字符串,对象的简写法等都能让代码变得干净利落。
比如一个判断奇偶的函数

function isEven(x){
    return x % 2 == 0
}

ES6:

const isEven = x => x % 2 == 0

比如字符串拼接

dom.innerHTML='Hello '
    + name
    + ',How you today?'

ES6:

dom.innerHTML=`Hello 
    ${name}
    How you today?`

一些优雅的写法

逻辑运算符

if (a == 1) {
    b()
}
//可以写成
a == 1 && b()

初始化变量

var a = obj || {}

三元运算符

var a = b % 2 == 0 ? 'even' : 'odd'

合理的命名

具体来说有这样几点:

  • 方法名以动词开头,比如 var getName = function(){}
  • 布尔值以is开头,var isEven = function(x){return x % 2 == 0}
  • 驼峰大小写和下划线不要混用,比如whatTheHellwhat_the_hell
  • 下划线只有在私有对象属性时使用
  • 方法内部变量尽可能短

变量声明

变量声明尽可能的放在开头,这样有助于:

  • 提供一个单一地址查找到函数所有需要的局部变量
  • 防止因声明提升所引发的逻辑错误
  • 帮助牢记要声明的变量,尽可能地少适用全局变量

使用逗号隔开换行,而非每一行重新var

var a = 1
var b = 2
//换成
var a = 1,
    b = 2

有的时候也可以把逗号写在开头,这样比较方便加入新的变量

var a = 1
   ,b = 2
   ,c = 3

对齐方式

var express =   require('express')
var path =      require('path')
var favicon =   require('serve-favicon')
var logger =    require('morgan')

实际上用var的时候是可以用逗号的。所以在ES6中更经常出现的情况:

import Vue          from 'vue'
import VueResource  from 'vue-resource'
import VueValidator from 'vue-validator'
import VueRouter    from 'vue-router'
import Vuex         from 'vuex'

缩短常用方法名

var $ = function(x){
    return document.getElementById(x)
}

避免超长代码

如果代码长到底部的滚动条都出现了,如何算得上优雅呢。
所以要保持每一行的代码不要太长,具体有这样需要注意的地方:

  • 内部不重要的过程性代码尽可能短,但至少保留语义
  • 如果用到链式语法,可在 ' . '的开头换行
[].concat(arr).sort().forEach(fn)...

可以改成

[].concat(arr)
    .sort()
    .forEach(fn)...
  • 字符串拼接时,用加号换行,或用ES6的模板字符串
  • 如果因为逻辑运算符儿导致过长,可以将逻辑运算符换行
  • 如果函数参数过长,可以将参数换行,也是没问题的
  • 尽可能避免嵌套过多的if语句
  • 如果还是很长,可以尝试2个空格缩进

其他细节

  • 代码不同功能区之间加空行,比如每个funtion之间
  • 对于数组或类数组,可以用map等函数替代for循环
  • + 号的运算符之间加空格
  • 若多次引用同一外部对象的属性,则定义到方法内部

最后

在实践中还有很多可以注意的地方,以后也会慢慢完善。
当然,也欢迎一起补充~~
写优雅的代码是很令人愉悦的。

代码如诗~

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

推荐阅读更多精彩内容