如何让你的JS代码更好看易读

作为JS程序员,自己写的代码如果好看易读,不只是自己看起来好看,在别的程序员接手以后,也会是交接工作异常顺利。

不要在代码中留大段注释掉的代码

留给git去管理,不然你要git干嘛

rush:xhtml;"> // bad

// function add() {
// const a = b + c
// return a
// }

function add() {
return a + 1000
}

// good
function add() {
return a + 1000
}

适当地换行

rush:xhtml;"> // bad function a() { const { state_a,state_b,state_c } = this.state this.setState({state_a: state_a * 2}) return 'done' }

// good
function a() {
const {
state_a,state_c
} = this.state

this.setState({state_a: state_a * 2})

return 'done'
}

适当的添加注释,但不要疯狂的添加注释

对一段代码或者一行特别需要注意的代码注释

不要疯狂的注释,太啰嗦,漂亮的代码自己会说话

rush:xhtml;"> // bad const a = 'a' // 这是a const b = 'b' // 这是b const c = 'c' // 这是c

// good
/**

  • 申明变量
    */
    const a = 'a'
    const b = 'b'
    const c = 'c'

将类似行为、命名的代码归类在一起

arr.map(e => e + a)

const b = 2

return arr.length + b
}

// good
function handleClick(arr) {
const a = 1
const b = 2

arr.map(e => e + a)

return arr.length + b
}

在不破坏语义性的情况下,'能省则省'

牢记js中函数是一等公民

但是,如果省略到影响可读性了,就是失败的

在可读性和简洁性至今必须选一个的话,永远先选可读性

function doSomething() {

}

// bad
arr.map(a => {
return add(a)
})

setTimeout(() => {
doSomething()
},1000)

// good
arr.map(add)

setTimeout(doSomething,1000)

箭头函数

{ return v + 1 }

// good
const a = v => v + 1

// bad
const b = (v,i) => {
return {
v,i
}
}

// good
const b = (v,i) => ({v,i})

// bad
const c = () => {
return (dispatch) => {
// doSomething
}
}

// good
const c = () => dispatch => {
// doSomething
}

提前对对象取值(写react的同学一定懂)

rush:xhtml;"> // bad const a = this.props.prop_a + this.props.prop_b

this.props.fun()

// good
const {
prop_a,prop_b,fun
} = this.props

const a = prop_a + prop_b

fun()

合理使用各种表达式

rush:xhtml;"> // bad if (cb) { cb() }

// good
cb && cb()

// bad
if (a) {
return b
} else {
return c
}

// good
return a ? b : c

// bad
if (a) {
c = a
} else {
c = 'default'
}

// good
c = a || 'default'

链式调用写法

{ return res.json() }).then(() => { // doSomething }).catch(e => {

})

// good
fetch(url)
.then(res => {
return res.json()
})
.then(() => {
// doSomething
})
.catch(e => {

})

保持代码是纵向发展的

发现那些在整个文件中特别'突出'的代码时,应该考虑对他们做换行处理了

rush:xhtml;"> // bad return handleClick(type,key,ref,self,source,props)

// good
return handleClick(
type,props
)

// bad
const a = this.props.prop_a === 'hello' ? world

: null

// good
const a = this.props.prop_a === 'hello'
? world


: null

相关文章

前言 做过web项目开发的人对layer弹层组件肯定不陌生,作为l...
前言 前端表单校验是过滤无效数据、假数据、有毒数据的第一步...
前言 图片上传是web项目常见的需求,我基于之前的博客的代码...
前言 导出Excel文件这个功能,通常都是在后端实现返回前端一...
前言 众所周知,js是单线程的,从上往下,从左往右依次执行,...
前言 项目开发中,我们可能会碰到这样的需求:select标签,禁...