← 返回首页

像写文章一样写代码

给未来的自己留下一条能够读懂的线索。

代码最终是给机器执行的,但它也一直被人阅读。读代码的人可能是同事,也可能是几个月后的自己。

我喜欢把一个函数看成一个短段落:它应该有清楚的目的,尽量只说一件事,并且让下一段自然地接上来。

名字是第一句说明

好的命名不能解决所有问题,却能减少很多无谓的猜测。读者不用在几个文件之间来回跳转,就能大致明白一段代码的意图。

遇到复杂逻辑时,先写下为什么要这样做。实现可以重构,问题的背景却很容易随着时间一起消失。