如何编写能解释代码决策的注释。
注释应解释意图或不明显的约束。用文字重复一行简单代码只会增加噪声。
按任务需求调整流程。
识别代码背后不明显的原因、不变量或约束，并在相关操作附近解释。删除只复述简单语法的注释，保持解释与真实行为一致。
- 你需要提供什么
- 代码和项目文档风格。
- 你会得到什么
- 解释意图与约束的有用注释。
查看输入和结果。
演示用输入和输出 · 教学示例，并非 WebAct 实时运行结果
示例 个输入项
Add an intent comment to this JavaScript mapping. Original row IDs must remain available so reviewers can trace comparison results to their sources.
const copied = rows.map(row => ({ ...row }));完整示例
// Retain source row IDs so reviewers can trace each comparison finding.
const copied = rows.map(row => ({ ...row }));
The comment explains why the IDs remain. The code still makes shallow copies; nested objects are shared.将这份输入载入提示词，再复制到 WebAct 中尝试任务。实际结果可能与示例不同。
决策与问题排查。
每个赋值语句都需要注释吗？
在意图或约束原本不清楚的地方注释。用文字重复代码会增加维护工作，却不能解释决策。
为什么有用的注释在重构后变得误导？
结合变化后的行为检查注释，更新或删除过时假设。注释也是需要维护的解释的一部分。
使用自己的资料试一试。
将任务提示词中的示例换成你的材料。保留所需条件，再把任务复制到 WebAct。
自定义并复制任务 ↑