命名和实际做的事对不上

函数名叫保存,读的人会以为它只写库。里面还发了通知、写了一条审计。调用方漏看了副作用,在不该通知的路径上也调了它。

我没有立刻大改名字,先在调用处加了说明,并把发通知做成参数,默认保持原样,避免一次性改出更多行为变化。

新的调用点使用明确的名字:只保存,或保存并通知。旧名字标成不推荐,注释写明替代的两个函数。

测试分成两条。一条断言没有通知,一条断言通知发出去了。以前只有一条,看不出副作用。

评审时我们多看了一眼名字和函数体的第一屏。名字承诺的事如果包不住函数体,就要求拆开或改名。

这次之后,同类的‘保存’不再偷偷做事。排查通知发重了的问题时,路径清楚了很多。

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

记录里保留失败的那一次。只写成功,别人学不到边界。失败时的输出、当时的配置、本来期望发生什么,三样放在一起。修好之后补一句:如果再出现,先看哪一行。没有这句,这篇就只是故事。

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

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

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

4 个赞

函数名叫保存却发通知,调用的人会漏。副作用写在名字或旁边的一行说明里。

2 个赞