先打印将要做什么

「先打印将要做什么」。

确认再执行真正的修改。多这一步,少一次误删。

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

脚本要敢再跑一次:空参数直接退出,做完的步骤跳过,失败用非零退出码。真正修改之前先打印将要做什么。密码和家目录路径不要写死。日志追加到固定文件,定时跑失败才有人能看见。文件开头写清参数和一条例子。

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

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

补充记录。脚本按能再跑一次来写。空参数直接退出并说明缺什么,不能让空值把范围变宽。已经完成的步骤跳过。失败用非零退出码,否则调用方会继续。真正修改之前先打印将要做什么,确认再执行。密码放环境或单独文件,路径当参数,不写家目录。日志追加到固定文件,定时任务失败才看得见。文件开头写参数和一条例子。没有这几行,下周的自己也看不懂,别人更不敢跑。

操作顺序。1. 文件开头写参数和一条例子。2. 空参数立刻退出,并说明缺什么。3. 执行修改前先打印将要做什么。4. 已完成的步骤跳过,保证可以再跑。5. 失败使用非零退出码。6. 密码来自环境或单独文件,路径来自参数。7. 日志追加到固定位置。8. 自己按说明从空目录跑通,再故意缺一个参数看它会不会把范围改宽。会改宽,就不能给定时任务用。定时跑的失败如果只打印在当时的屏幕上,等于没有记录。

4 个赞

真正修改之前,先打印将要做什么。多这一步,少一次误删。

2 个赞