注释还写着旧参数

我按注释里的参数名去传,接口说没有这个参数。代码里的名字半年前就换了,注释没改。

过期注释比没有注释更费时间。没有注释我会去读代码,有错注释我会先相信它。

这次把注释改成新名字,并搜了一遍旧名字。提示文案、示例、测试描述里还各有一处。

约定改成:改参数名的提交里,必须包含对旧名字的搜索。搜索没有结果再提交。

这个约定写在贡献说明的三行里,不写成很长的规范。越长越没有人在提交前看。

之后我又碰到一次旧名字,是在另一份仓库的示例里。主仓库的搜索覆盖不到那里,所以示例仓库也加了同一句。

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

给后来的人看,所以写能照着做的步骤,不写感受。每一步写期望看到什么。看不到,就停在这一步,不要继续往下猜。步骤结束以后,用干净环境再做一次。自己的机器上能过,只能说明自己的机器上能过。

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

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

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

8 个赞

改参数名时搜一遍旧名字,注释和提示文案一起改。过期注释比没有注释更误事。

3 个赞