核心工作流06 / 16
阅读实现说明与证据
本页内容
实现说明让你从一段意图出发,理解当前代码如何工作,并找到支持这些说明的依据。阅读时,把注意力放在行为、证据和仍需判断的问题上。
打开段落与局部说明
在文档中,点击文字可以编辑;点击段落内文字之外的空白,可以打开这段内容的总体说明,界面标记为“L1”。
有些说明针对段落中的某个词或短语。鼠标移到段落上时,这些位置下方会出现短横线,点击即可阅读局部说明,界面标记为“L2”。
列表、表格和代码块也可以有各自的说明。整个列表一起调查,标题本身不单独调查。
多个段落的旁注可以同时保留。同一段落的旁注每次显示一份总体或局部说明;窗口较窄时,旁注可能显示在该段落下方。
阅读三个区域
| 区域 | 回答的问题 | 阅读时关注什么 |
|---|---|---|
| 实现 | 当前实现如何回应这段意图 | 行为、处理步骤、边界条件和实现选择 |
| 依据 | 说明建立在什么材料上 | 代码引用、测试、命令输出及其他可检查材料 |
| 关注 | 哪些事情需要进一步判断 | 缺口、实现选择、风险和建议 |
“实现”默认展开,“依据”可以按需展开;没有关注事项时,不显示“关注”区域。
例如,对于“连续打卡满 7 天发放奖励”,实现说明可能描述日期如何累计,依据指向相应函数和测试,而关注事项提醒你确认跨时区时的计算口径。具体内容以项目中的调查结果为准。
查看依据
点击代码引用,会用系统默认程序打开对应文件。图片可以在旁注中查看并放大;点击命令输出或代码差异等材料的标签,会在新标签页中打开。材料已经不存在时,界面会提示。
检查依据时,可以逐项问:引用是否对应当前问题;测试覆盖的是哪种条件;结果是否支持说明中的结论。如果缺少关键场景,可以对该段落发起提问,请 Agent 补充调查或验证。
尤其要区分以下三种证据:
| 看到的材料 | 能帮助你确认什么 | 还需要区分什么 |
|---|---|---|
| 实现代码或测试代码 | 代码采用了什么逻辑,测试定义了哪些场景 | 存在测试代码不表示测试已经执行或通过 |
| 以前的执行结果 | 当时运行了什么,以及当时的结果 | 后续代码变化可能影响结果是否仍适用 |
| 本次实际执行的验证 | 当前这次执行在指定环境和范围内的结果 | 通过的场景不代表未覆盖的场景也正确 |
“解释”和“调查”默认读取代码与已有证据,不会每次重新运行测试、构建或应用。只有读代码仍无法确认某个影响判断的关键事实时,才按需要验证该事实。因此,要根据实际执行的内容判断验证范围。
需要重新运行某项测试时,在对话中要求 Agent 执行并说明验证范围和结果,然后重新调查相关段落。
判断实现选择是否需要写回意图
实现说明中的“当前使用本地存储”描述的是现有做法,不意味着以后的版本也必须这样做。你决定长期保留的要求,应写入意图文档。
看到一项选择时,可以先问它是否影响体验、成本、隐私、风险或后续决定。理解之后有两种常见处理:
- 当前做法可以接受,也愿意保留今后调整的空间:继续使用现有实现,无需把这项选择写成约束。
- 这项做法是未来也必须满足的要求:明确写入意图,并审阅它可能带来的限制。
例如,你可以接受目前本地保存打卡记录;如果离线使用已成为必须满足的行为,可以写入“无网络时仍能完成打卡”,再调查实现如何保障它。表达你真正要求的行为,通常比照抄整段实现细节更便于维护。
理解关注事项
关注事项分为“缺口”“实现选择”“风险”和“建议”。它们帮助你区分需要补齐的行为、已经采用的做法,以及值得进一步讨论的事情。
段落右侧的关注标记会带你打开相关说明。数字表示含关注事项的说明面板数量,不等于问题条数。存在缺口时,标记会用更醒目的颜色呈现。
先了解关注事项的影响,再决定修复代码、补充验证、修改意图,或保留当前做法。它们不必全部变成新要求;没有关注标记,也只表示当前说明未列出关注事项。
使用行为示意
部分实现说明会包含“行为示意”,用小型交互界面帮助理解规则。可以尝试操作、复位,或查看源码。
行为示意在独立沙箱中运行,不能访问应用和网络,也不保存交互状态。它用于解释行为;判断真实软件是否做到这一点,还需要检查代码和验证材料。
先确认说明是否仍适用
看到“先前文字”时,说明针对的是你修改前的意图。看到“可能已过时”时,说明读取或引用的文件在调查之后发生了变化。两种情况都值得重新调查。
旁注内容在界面中只读。想调整要求时编辑意图;想核实说明时使用“调查”或“重新调查”。具体步骤见让说明跟上变化。