代码语言

知识点思维导图

24 个知识节点

参考资料

Claude Code（08） - 写测试与处理文档：参与完整开发闭环

读完后，你应能完成以下任务：

绘制“Claude Code（08） - 写测试与处理文档：参与完整开发闭环 / 为什么是这一章”的关键对象与数据流，解释“真实开发里，一段代码能不能被接受，取决于它有没有通过测试、符不符合规范、经没经过审查。”，并用源码位置、日志或 Trace 标注证据。

为“Claude Code（08） - 写测试与处理文档：参与完整开发闭环 / 写测试：四步法”设计正常与异常输入，验证“第 3 步：补边界情况（最有价值的一步）”，输出首个偏差位置与回归测试结果。

实现“Claude Code（08） - 写测试与处理文档：参与完整开发闭环 / 处理文档：四步法”的最小代码或配置，检验“第 2 步：生成文档（指定风格）”，输出命令、结果与 Diff，并说明不适用边界。

本章目标：让 Claude Code 补测试、跑测试、生成与校对文档。

一、先建立全局：写测试与处理文档：参与完整开发闭环是什么？

理解“写测试与处理文档：参与完整开发闭环”，先要把标题中的对象放进同一条处理链：它接收什么输入，经过哪些状态变化，最终用什么证据判断结果。下表不另造概念，只把作者正文已经解释的章节按依赖顺序连起来。

“写测试与处理文档：参与完整开发闭环”的第一个核心判断是：真实开发里，一段代码能不能被接受，取决于它有没有通过测试、符不符合规范、经没经过审查。。先弄清这个判断中的对象和输入输出，后面的实现、故障和验收才有共同语境。

顺序	章节	读完本节应抓住的结论
1	为什么是这一章	真实开发里，一段代码能不能被接受，取决于它有没有通过测试、符不符合规范、经没经过审查。
2	写测试：四步法	第 3 步：补边界情况（最有价值的一步）
3	处理文档：四步法	第 2 步：生成文档（指定风格）
4	串进日常：让它成为习惯	把「实现完顺手补测试和文档」写进 CLAUDE.md（第 05 章），
5	常见错误	正常用例价值有限，点名让它覆盖边界和异常才值。
6	最佳实践	测试重点压在边界：异常、空值、并发、失败重试，明确点名。 -> 测试必跑必验证：让它「跑新测试并修复失败」。 -> 文档指定风格 + 带示例：JSDoc/docstring 选一种，要求给用法示例。 -> 闭环写进 CLAUDE.md：让补测试、补文档成为它的默认动作。

1.1 核心对象之间怎样衔接

flowchart LR
  S1["为什么是这一章"] --> S2
  S2["写测试：四步法"] --> S3
  S3["处理文档：四步法"] --> S4
  S4["串进日常：让它成为习惯"] --> S5
  S5["常见错误"]

这张图只表达本文的讲解顺序，不替代正文机制。判断“写测试与处理文档：参与完整开发闭环”是否真正掌握，需要能从最后一个结果沿图回到前面每个章节的输入、状态变化和证据。

1.2 再看失败：问题最早会出现在哪一步？

在“写测试与处理文档：参与完整开发闭环”的对象和顺序已经明确后，再看可观察的失败：条件缺失、结果不可复现或失败后责任不清。定位时不从最后一条错误猜原因，而是沿上图找第一个偏离正文结论的节点。

二、为什么是这一章

如果只用它「生成代码」，价值大打折扣。真实开发里，一段代码能不能被接受，取决于它有没有通过测试、符不符合规范、经没经过审查。让它参与完整开发闭环，才是正确用法：

实现修改 → 编写/更新测试 → 跑测试 → 跑 lint/类型检查 → 审查 diff

它从「代码生成器」变成「开发循环里的执行节点」。本章讲其中两环：测试和文档。

三、写测试：四步法

第 1 步：找出没被测到的代码

在 @notification.js 中查找未被测试覆盖的函数

第 2 步：生成测试骨架

为通知服务添加测试用例

第 3 步：补边界情况（最有价值的一步）

为通知服务补充边界条件的测试：空收件人、超长内容、发送失败重试

💡 普通用例它生成得又快又好，真正的价值在边界情况——明确点名让它覆盖异常路径。

第 4 步：跑测试并修失败

运行新写的测试，修复任何失败项

这一步闭环：它跑测试 → 没过 → 自己改 → 再跑，直到全绿。

四、处理文档：四步法

第 1 步：找出没文档的代码

在 @auth 模块里找出没有 JSDoc 注释的函数

第 2 步：生成文档（指定风格）

给 @auth.js 里没注释的函数补上 JSDoc，包含参数说明和一个使用示例

关键：指定风格（JSDoc / docstring / TSDoc…）并要求带示例，产出才好用。

第 3 步：审查增强

给这些文档补充更多上下文和边界说明

第 4 步：对照规范校验

检查这些文档是否符合我们项目的注释规范（见 CLAUDE.md）

五、串进日常：让它成为习惯

把「实现完顺手补测试和文档」写进 CLAUDE.md（第 05 章），它每次改完业务逻辑就会主动补：

# 开发闭环要求
- 改动业务逻辑后必须补/更新对应测试，并运行 `pnpm test`
- 新增公共函数必须带 JSDoc，包含参数说明和使用示例

六、常见错误

错误 1：只让它写「正常路径」测试 正常用例价值有限，点名让它覆盖边界和异常才值。

错误 2：生成测试不跑 没跑过的测试可能本身就是错的。→ 永远让它「跑新测试并修失败」。

错误 3：文档不指定风格 不说 JSDoc 还是 docstring，风格会乱。 → 明确风格 + 要示例。

错误 4：把文档当一次性任务 代码改了文档没改 = 误导。 → 把「改代码同步改文档」写进 CLAUDE.md。

七、最佳实践

测试重点压在边界：异常、空值、并发、失败重试，明确点名。
测试必跑必验证：让它「跑新测试并修复失败」。
文档指定风格 + 带示例：JSDoc/docstring 选一种，要求给用法示例。
闭环写进 CLAUDE.md：让补测试、补文档成为它的默认动作。

八、动手实践：Demo 08 · 补测试与补文档实战

一个没有测试、也没有文档的小模块（密码强度校验）。用来练习本章两个四步法：补测试、补文档。

8.1 文件说明

password.js：密码强度校验，函数没注释、没测试，正等你补。

8.2 练补测试（四步法）

1.（找空白）@password.js 里哪些函数没有测试覆盖？
2.（生成）为 password.js 写测试（用 node 自带 assert，输出到 password.test.js）。
3.（补边界）补充边界用例：空字符串、纯数字、超长、刚好达到/差一位达标。
4.（跑并修）运行 `node password.test.js`，修复任何失败。

8.3 练补文档（四步法）

1.（找空白）@password.js 里哪些函数没有 JSDoc？
2.（生成）给它们补 JSDoc，含参数说明和一个使用示例。
3.（增强）补充边界说明（如各规则的具体含义）。
4.（校验）检查注释是否符合「每个函数和参数都要注释」的规范。

九、动手验证：先跑通写测试与处理文档：参与完整开发闭环，再改变一个变量

前面的章节已经建立问题、概念和机制。现在把“写测试与处理文档：参与完整开发闭环”放进同一套基线中运行；本节不再引入新术语，只验证前文结论能否被复现。

9.1 基线与候选只允许一个变量不同

验证“写测试与处理文档：参与完整开发闭环”时，先固定样本、基线、候选、成功标准和失败边界。候选方案只能改变本次要验证的变量；如果同时更换数据、依赖和配置，即使结果改善，也不能知道是哪一项产生作用。

执行“写测试与处理文档：参与完整开发闭环”时，动作是：同环境运行基线与候选，记录输入、中间状态和异常。原始结果不能只保留截图或汇总分数，必须同步保存：可重放命令、结构化日志、输出 Diff、失败样本、版本，使下一次复查可以在同一输入上重放。

实验要素	本文要求
固定条件	固定样本、基线、候选、成功标准和失败边界
唯一变量	本次候选方案与基线之间的一项明确差异
原始证据	可重放命令、结构化日志、输出 Diff、失败样本、版本
通过阈值	结果符合结论条件，异常输入可解释、可恢复
立即停止	条件缺失、结果不可复现或失败后责任不清

9.2 执行前先排除不可比较条件

“写测试与处理文档：参与完整开发闭环”开始前先确认下面四项；任一项不成立，都应先修复实验条件，而不是解释结果。

基线能够在“写测试与处理文档：参与完整开发闭环”的当前环境重复运行。
候选只改变一个与“写测试与处理文档：参与完整开发闭环”结论直接相关的条件。
“写测试与处理文档：参与完整开发闭环”的基线和候选使用同一批输入、同一版本依赖与同一通过阈值。
“写测试与处理文档：参与完整开发闭环”的原始输出和失败现场不会被重试、格式化或汇总覆盖。

9.3 执行后先核对证据完整性

结果出来后先检查证据，再讨论“写测试与处理文档：参与完整开发闭环”是否通过。缺少中间状态时，最终输出只能说明现象，不能证明机制。

检查项	当前文章的判定
输入可追溯	固定样本、基线、候选、成功标准和失败边界
过程可回放	同环境运行基线与候选，记录输入、中间状态和异常
结果可审计	可重放命令、结构化日志、输出 Diff、失败样本、版本

“写测试与处理文档：参与完整开发闭环”的一次合格基线对照按以下顺序执行：

保存“写测试与处理文档：参与完整开发闭环”基线版本及输入摘要，确认基线本身可以重复运行。
写下“写测试与处理文档：参与完整开发闭环”候选方案唯一变化的变量，以及它预期影响的指标。
在同一环境执行“写测试与处理文档：参与完整开发闭环”：同环境运行基线与候选，记录输入、中间状态和异常。
为“写测试与处理文档：参与完整开发闭环”保存：可重放命令、结构化日志、输出 Diff、失败样本、版本。
使用“写测试与处理文档：参与完整开发闭环”预登记条件判断：结果符合结论条件，异常输入可解释、可恢复。
如果“写测试与处理文档：参与完整开发闭环”未通过，不修改第二个变量，先恢复基线并保留失败现场。

十、用一张矩阵验证写测试与处理文档：参与完整开发闭环的关键结论

矩阵按正文顺序列出“写测试与处理文档：参与完整开发闭环”的结论。一次实验只选择一行，只改变这一行对应的条件；不要把多行合并成一个无法归因的大实验。

正文章节	已解释的结论	本轮唯一变量	必须保存的证据
为什么是这一章	真实开发里，一段代码能不能被接受，取决于它有没有通过测试、符不符合规范、经没经过审查。	只改变与“为什么是这一章”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
写测试：四步法	第 3 步：补边界情况（最有价值的一步）	只改变与“写测试：四步法”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
处理文档：四步法	第 2 步：生成文档（指定风格）	只改变与“处理文档：四步法”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
串进日常：让它成为习惯	把「实现完顺手补测试和文档」写进 CLAUDE.md（第 05 章），	只改变与“串进日常：让它成为习惯”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
常见错误	正常用例价值有限，点名让它覆盖边界和异常才值。	只改变与“常见错误”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
最佳实践	测试重点压在边界：异常、空值、并发、失败重试，明确点名。 -> 测试必跑必验证：让它「跑新测试并修复失败」。 -> 文档指定风格 + 带示例：JSDoc/docstring 选一种，要求给用法示例。 -> 闭环写进 CLAUDE.md：让补测试、补文档成为它的默认动作。	只改变与“最佳实践”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本

10.1 记录本次实际实验

下面的记录用于“写测试与处理文档：参与完整开发闭环”当前这一次实验，不是第二套知识目录。先从矩阵选择一个章节，再填写实际值；没有填写的字段表示尚未验证。

topic: "写测试与处理文档：参与完整开发闭环"
selected_chapter: required
claim_from_article: required
baseline_version: required
changed_condition: exactly_one
execution: "同环境运行基线与候选，记录输入、中间状态和异常"
evidence: "可重放命令、结构化日志、输出 Diff、失败样本、版本"
pass_when: "结果符合结论条件，异常输入可解释、可恢复"
stop_when: "条件缺失、结果不可复现或失败后责任不清"
observed_result: required
first_deviation: null_or_evidence
recovery_replay: required_after_failure

10.2 边界实验必须证明能够停止和恢复

成功路径只能证明“写测试与处理文档：参与完整开发闭环”在当前样本上工作，不能证明它可以进入生产。边界实验需要主动制造：条件缺失、结果不可复现或失败后责任不清，并观察系统是否在产生不可逆副作用前停止。

场景	只改变什么	应保存什么	通过标准
正常路径	使用已知有效输入	可重放命令、结构化日志、输出 Diff、失败样本、版本	结果符合结论条件，异常输入可解释、可恢复
边界路径	把一个输入推进到约束临界值	临界值前后的输出与指标	不静默降级，不把部分结果冒充成功
明确失败	注入：条件缺失、结果不可复现或失败后责任不清	原始错误、首个异常阶段和最终状态	失败被正确分类且没有扩大副作用
恢复重放	执行：保留基线，缩小变量；根因确认前不扩大范围	原失败样本的复测证据	原样本恢复，正常样本没有回归

恢复动作不是简单重启。对于“写测试与处理文档：参与完整开发闭环”，第一步是：保留基线，缩小变量；根因确认前不扩大范围。完成后使用原始失败样本复测；只验证一个新样本成功，不能证明触发条件已经消失。

“写测试与处理文档：参与完整开发闭环”边界实验结束后，应把正常、临界、失败和恢复四类记录放在同一个运行批次中。这样才能区分“候选方案真的修复问题”和“环境变化让问题暂时没有出现”。

十一、写测试与处理文档：参与完整开发闭环的结果解释

解释“写测试与处理文档：参与完整开发闭环”实验时先看首个偏差，而不是最后一条错误。最后的异常通常只是上游状态错误的结果；从末端反推容易误把症状当根因。

观察结果	可以支持的判断	下一步
主链路没有达到预期	条件缺失、结果不可复现或失败后责任不清	先执行：保留基线，缩小变量；根因确认前不扩大范围
异常链路无法恢复	条件缺失、结果不可复现或失败后责任不清	先执行：保留基线，缩小变量；根因确认前不扩大范围
新样本成功但原样本仍失败	修复没有覆盖原始触发条件	固定原失败输入，恢复基线后重新比较
指标改善但证据无法回链	数据、版本或中间状态没有固定	暂停发布，补齐可追溯记录后重跑

“写测试与处理文档：参与完整开发闭环”只有同时满足“结果符合结论条件，异常输入可解释、可恢复”，并且没有出现“条件缺失、结果不可复现或失败后责任不清”，才可以认为主链路通过。这里的“通过”只对当前固定版本、样本和环境有效，不能外推到尚未测试的容量、权限或数据分布。

如果“写测试与处理文档：参与完整开发闭环”候选方案与基线差异很小，先检查证据分辨率是否足够；如果差异很大，先排除数据泄漏、环境漂移和版本不一致。两种情况都不能只看一个汇总均值，需要回到逐样本输出和中间状态。

“写测试与处理文档：参与完整开发闭环”故障定位完成后，记录“现象、首个偏差、根因、改动、原样本复测”五项。缺少原样本复测时，只能标记为待观察，不能标记为已解决。

十二、写测试与处理文档：参与完整开发闭环的发布判断

发布判断需要把“写测试与处理文档：参与完整开发闭环”的质量、失败边界和恢复能力放在同一份记录中。以下任一条件缺失，都应停止扩量，而不是用“基本正常”替代证据。

“写测试与处理文档：参与完整开发闭环”的基线与候选只存在一个计划内变量。
“写测试与处理文档：参与完整开发闭环”的输入、代码、依赖、配置和数据版本可以追溯。
“写测试与处理文档：参与完整开发闭环”的正常、临界、失败和恢复样本使用同一套断言。
“写测试与处理文档：参与完整开发闭环”的原始输出、中间状态和失败现场已经保留。
“写测试与处理文档：参与完整开发闭环”的日志、Trace、截图和测试数据已经脱敏。
“写测试与处理文档：参与完整开发闭环”的停止条件、负责人和回滚入口已经演练。
“写测试与处理文档：参与完整开发闭环”尚未覆盖的输入、权限、容量和外部依赖已经登记。

最终记录至少包含基线版本、唯一变量、原始证据、首个偏差、恢复复测和发布责任人。没有参与本次修改的人如果不能据此重放“写测试与处理文档：参与完整开发闭环”的判断，就不能发布。

十三、总结

为什么是这一章：真实开发里，一段代码能不能被接受，取决于它有没有通过测试、符不符合规范、经没经过审查。
写测试：四步法：第 3 步：补边界情况（最有价值的一步）
处理文档：四步法：第 2 步：生成文档（指定风格）
串进日常：让它成为习惯：把「实现完顺手补测试和文档」写进 CLAUDE.md（第 05 章），它每次改完业务逻辑就会主动补：
常见错误：正常用例价值有限，点名让它覆盖边界和异常才值。
最佳实践：测试重点压在边界：异常、空值、并发、失败重试，明确点名。 -> 测试必跑必验证：让它「跑新测试并修复失败」。 -> 文档指定风格 + 带示例：JSDoc/docstring 选一种，要求给用法示例。 -> 闭环写进 CLAUDE.md：让补测试、补文档成为它的默认动作。