致来者
2025年12月15日 · 约 567 字
接手过一个别人写的模块。
两千行,一个方法从头写到尾,中间没有分段。变量名是 a1、tmp、data2。
我花了三天,才敢改第一行。
那三天里我一直在猜:他当时在想什么?为什么这里要多加一个判断?这个循环为什么提前跳出去?
猜不出来。他不写注释,大概是觉得没必要——代码就是注释。
自己也会变前人
后来自己也变成了"前人"。
三年前写的一段逻辑,现在打开,第一反应是"这谁写的"。看清楚才发现是自己。当时觉得理所当然的地方,现在完全想不起来为什么。
那种感觉很怪。像收到一封自己写的信,字迹熟悉,内容陌生。
从那以后
写字会多想一步。
变量名写全,usrMgr 改成 userManager,多敲几个字母。函数名写"做什么"不写"怎么做"。
出错的地方要留线索。超时、格式不对、没权限,这三种得能分开,不能统一变成"操作失败"——那样等于什么都没说。
不可逆的操作前先留退路。迁移前打快照,批量改之前先导出。顺利的时候这些动作看着多余,出事的时候它们是救命的。
吃过亏才长的记性
这些都不是规范要求,是吃过亏之后长出来的。
有次线上出问题,日志里只有一句"error"。查了四个小时,最后靠猜。那四个小时我一直在想:当时要是多写一行,现在是不是已经喝上茶了。
致来者,其实就是写给未来的自己。
希望那个人打开文件时,不用先花三天猜我。