读库函数时先看测试名

注释写得很满,我读完仍不确定这个函数在失败时返回什么。测试名字写的是‘找不到时返回空,而不是报错’。

以测试为准去读实现,果然和注释有一处相反。注释是旧行为,测试在后来改过,注释没跟着改。

我按测试描述改了注释,没有改行为。因为调用方已经按测试所描述的方式在用。

以后读不熟的函数,我先读测试名字,再读实现,注释放到第三位。注释会过期,测试不过期的话构建是红的。

也不是所有测试名字都可信。名字和断言相反时,以断言为准,并把名字改掉。这次就有一条名字说‘报错’,断言却是返回空。

读完把‘失败时到底怎样’用一句话写回注释。这句话和测试名字、断言三者一致。

读一段不熟的实现,我先写调用顺序,再进文件。测试名字和断言放在注释前面,因为注释会过期,测试红了会有人看见。函数名承诺的事如果包不住函数体,就拆开或改名,不要靠调用方记得副作用。改完用这条路径的成功、失败、缺参数各走一遍。

这次按时间写。先发生什么,中间查了什么,最后留下什么。不把后来才知道的结论写成一开始就想到了。查的时候把猜的和已经验证的分开,避免第二天把猜测当成事实。验证用的是改之前的同一条路径,不是换一组更容易过的输入。

复查「读库函数时先看测试名」时按这四步,不靠感觉。用改之前的同一组输入再走一遍,结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名,确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。

补充记录。读代码时我按固定顺序,避免在文件之间跳丢。先写六行调用:入口、校验、查询或计算、副作用、返回、失败时怎样。再看测试名字和断言,最后才看注释。注释和断言冲突时,以断言为准,然后把注释改掉。函数名如果包不住副作用,就拆成两个名字,让调用处自己选择。改完用成功、失败、缺参数三条输入各走一遍。三条结果必须不同。相同就说明失败被吞掉了,或者缺参数也被当成了成功。把这六行和三条结果留在提交说明里,后来的人不用再把调用栈走一遍。

操作顺序。1. 用六行写下入口、校验、查询、副作用、返回、失败时的结果。2. 打开对应测试,先读名字,再读断言。3. 名字、断言、注释三者不一致时,以断言为准改另外两处。4. 如果函数还做了名字里没有的事,拆出去或改名。5. 用成功、失败、缺参数三条输入各打一次,三条结果必须不同。6. 把六行调用和三条结果写进提交说明。后来的人按这六行读,不必再把文件跳一遍。

7 个赞

测试名字往往比注释准。先读测试承诺什么,再看实现有没有做到。

2 个赞