如何写出好的函数 (代码整洁之道笔记 函数篇)

440 阅读3分钟

本人在读完 《代码整洁之道》 函数章节后的笔记 截取了一些要点记录一下

(每一句都是干货 没有重点 全是重点)

1. 短小 函数的第一原则是要短小 第二规则是还要更短小 20行封顶最佳

2. if else while等语句 其中的代码块应该只有一行

if(code === 200) {
	saveData(data) 
} 

3. 函数的缩进层级不应该多于两层

4. 函数应该只做一件事 做好这件事 (1判断是否是页面 2如果是进行渲染 3不是做其他设置)

5. 单个函数中的语句需要再同一抽象层级

6. 使用描述性的名称 , 别害怕长名称 , 长而具有描述性的名称>描述性的长注释>短而费解的名称

7. 函数最好是没有参数,或者一个参数 (参数多余两个 测试组合量会大大增加)

8. 向函数传入布尔值简直就是骇人听闻的做法! 说明函数有两种情况 那么就应该将其分为两个函数

9. 多个函数参数可以统一传入参数对象 写三元以上函数一定要想清楚

const args = {name:'张三',age:18,sex:'男',...}
savePersonInfo(args)

10. 函数和参数应该形成一种良好的 动词/名词 的形式 : write(name)

11. 无副作用 对函数传入参数以外的地方进行修改 称为副作用 (比如在函数中重置localStorage) 这会增加时序性耦合 会引起不必要的顺序混乱

12. 函数要么 : 做一件事 要么: 回答一件事 两者不能混合。 比如函数应该修改某个对象数据,或者返回该对象的信息

13. 抽离try/catch代码块 最好把其主体部分抽出来 另外形成函数

try{
   getPage()
}catch(e){
   handleError(e)
}

14. 错误处理就是一件事 处理错误的函数不应该做其他事

15. 重复是软件中一切邪恶的根源

打磨代码:

写代码和写别的东西很像 在写论文或者文章时,先想写什么就写什么,然后再打磨它 反复斟酌推敲 直到达到你心目中的样子

体会:

函数是语言的动词, 类(对象)是名词, 编程艺术一直是一门语言设计的艺术

在我第一次读React源码的时候, 不禁发出感叹 “这一看就是大厂人写的代码!”

react源码外层的代码,没有多少声明,计算。基本都是函数调用,满眼都是很长的黄色函数名,

但是这些长函数名结合起来 讲述了一个故事, 读它就像是在读英语文章一样,想必这就是好的程序把。

希望读大家写出的代码就像是在读一篇英语文章,这样就好.

大师级程序员把程序当作故事来讲,而不是当作程序来写.