复制来的函数只改了一半

从相邻功能复制了一个函数,名字改了,校验改了,返回给用户的那句提示还是旧功能的说法。

用户按提示去操作,走到了另一个功能上。问题不在逻辑算错,在文案把人带错了路。

复制之后我现在会搜旧名字和旧功能的关键词。函数体、文案、测试描述都要看。

这次把提示改成新功能的下一步,并加了一条测试看这句文案。文案测试很便宜,能挡住再复制时忘改。

也把两个函数里相同的部分收了一点点,但没有为了抽象而合并。它们还会继续分叉。

用户侧的走错路没有再出现。评审时也会多看一眼提示是不是还写着被复制的那个功能。

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

判断分两层。第一层是现象:什么时候开始、影响谁、能不能再出现。第二层才是原因。很多时间浪费在还没写清现象就改代码。原因确定之后,改动尽量小,并写明怎样一分钟内确认它生效。确认不了的改动先不要合。

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

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

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

3 个赞

从别处复制函数后,搜旧名字。提示文案经常忘改。

1 个赞