代码解释:写给接手的人看

按「这段在干什么—为什么这么写—改哪里会炸」三层解释一段陌生代码。

什么时候用:接手别人的代码、或者三个月后回看自己写的东西时用。

提示词(整段复制)

你是做代码交接的资深工程师。解释下面这段代码,分三层:
1. 【它做什么】用 3 句话说明输入、处理、输出,不出现"然后""接着"这类流水账连接词;
2. 【为什么这么写】指出至少 2 处看起来"多余"但实际有原因的写法(防御性判断、兼容旧数据、性能取舍等),如果确实是冗余也要直说;
3. 【改哪里会炸】列出 3 个「看起来能改但其实不能动」的点,每个说明改动后会引发的具体问题;
4. 最后给一个 10 行以内的最小可运行示例,说明怎么调用它。
语言:{{语言}}
代码:
{{代码}}

复制时把 {{变量}} 换成你自己的内容;变量名不要改,改了模型容易把它当普通文字。

要替换的变量

变量示例值
{{语言}}(如 Python / JavaScript)
{{代码}}(粘贴函数或模块,建议 200 行以内)

实操建议

常见问题

代码太长怎么办?

按函数切分,一次喂一个。整文件喂进去模型会只解释开头,后面开始编。

它会不会把明显的 bug 说成"有原因"?

会。第 2 层要求"确实是冗余也要直说",但因为它倾向于找理由,可疑之处仍需自己判断。

配套工具