Tools

让小工具保持可维护

约 4 分钟

一个工具变得难以维护,通常不是因为代码太多,而是因为边界开始模糊:它接受什么、改变什么、失败后留下什么,都不再清楚。

先写下边界

动手之前,用几句话说明输入、输出和不会做的事情。这份说明不必完整,却能帮助后来的人判断某个新需求究竟属于修复、扩展,还是另一个工具。

让失败可被看见

静默失败最节省眼前的时间,也最容易把问题留到以后。明确的退出状态、能读懂的错误信息,以及不破坏旧结果的写入方式,往往比增加更多功能更有价值。

可靠并不意味着从不失败,而是失败时仍然保留下一步行动。

保留一条最短检查路径

不需要庞大的测试体系。先保留一组能够重复执行的基本检查:正常输入、错误输入和一次完整流程。工具每次改变后,都从这三处重新确认。

说明要靠近工具

简短的运行示例、依赖条件和恢复方法应该与工具放在一起。说明离实现越远,过期得越快。真正有用的文档,是下一次打开时能少猜几分钟。

返回全部笔记