# 开头写三行用法

**URL:** <https://buildx.do/t/%E5%BC%80%E5%A4%B4%E5%86%99%E4%B8%89%E8%A1%8C%E7%94%A8%E6%B3%95/225>\
**Category:** 筑码工坊\
**Tags:** 脚本开发\
**Created:** [2026 年10 月 7 日 17:53 UTC](https://buildx.do/t/%E5%BC%80%E5%A4%B4%E5%86%99%E4%B8%89%E8%A1%8C%E7%94%A8%E6%B3%95/225 "2026-10-07T17:53:00Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![zhaoan](https://buildx.do/letter_avatar_proxy/v4/letter/z/8edcca/32.png) [@zhaoan](https://buildx.do/u/zhaoan)\
**Post date:** [2026 年10 月 7 日 17:53 UTC](https://buildx.do/t/%E5%BC%80%E5%A4%B4%E5%86%99%E4%B8%89%E8%A1%8C%E7%94%A8%E6%B3%95/225/1 "2026-10-07T17:53:00Z")

</div>

「开头写三行用法」。

参数是什么，例子一条。没有这三行，下周的自己也看不懂。

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

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

先留现场，再动手。把当时的输入、输出、配置名抄下来，确认同一条路径还能再出现一次。不能再出现的现象，改完也不知道是不是改对了。确认之后只改一处。改两处的话，结果变了也分不清是哪一处。改完用同一组输入再走，结果要变成预期的那样，而不是仅仅没有报错。

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

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

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

---

<div class="post-metadata">

**Author:** ![wuqiao](https://buildx.do/letter_avatar_proxy/v4/letter/w/858c86/32.png) [@wuqiao](https://buildx.do/u/wuqiao)\
**Post date:** [2026 年10 月 7 日 18:58 UTC](https://buildx.do/t/%E5%BC%80%E5%A4%B4%E5%86%99%E4%B8%89%E8%A1%8C%E7%94%A8%E6%B3%95/225/2 "2026-10-07T18:58:00Z")

</div>

文件开头写清参数和一条例子。没有这个，下周的自己也看不懂。
