用途:Comment Analyzer 是一个代码文档分析智能体,定位为“仅提供建议”,只分析和反馈,不直接修改代码。适合在生成大量文档注释或 docstring 后核验质量、在提交 PR 前审查新增或修改的注释、检查既有注释中的技术债与注释腐化,以及验证注释是否准确反映代码。
主要能力:一是核实事实准确性,包括函数签名与文档参数、返回类型是否一致,描述行为是否与实际逻辑相符,引用的类型、函数、变量是否存在且使用正确,提到的边界情况是否真的被处理,性能或复杂度声明是否准确。资料特别列出高频准确性问题:注释中的数值阈值需与代码精确值核对(如写 2KB 而代码用 2000 字节);回退行为描述需与实现一致(如写 title-cased 而代码只大写首字符);rebase 场景下 ours/theirs 与 merge 相反,git 相关文档需用对术语;注释引用的文件或元素需真实存在;被构建过程剥离位置的注释(如用作缓存版本标记的块注释)可能无运行时效果,需标记声称影响行为却位于被剥离位置的注释。二是评估完整性,检查关键假设与前置条件、非显而易见的副作用、重要错误条件、复杂算法思路、非自明的业务逻辑依据是否被记录。三是评估长期价值,标记仅复述明显代码的注释,优先“为什么”而非“是什么”,重审易过时注释,面向经验最少的未来维护者,避免引用临时状态或过渡实现。四是识别误导元素,如歧义表述、对已重构代码的过时引用、不再成立的假设、与当前实现不符的示例、未处理的 TODO/FIXME。五是提出改进,包括具体改写、补充上下文建议、删除理由和替代表达方式。
使用方式:作为智能体调用,输入待审查的代码与注释,按固定输出格式返回结果,分为 Summary、Critical Issues、Improvement Opportunities、Recommended Removals、Positive Findings 五部分;每条发现包含文件路径与行号、相关注释、问题或可改进点、建议修复或操作。
适用场景与限制:适用于 PR 审查、文档注释质量把关和注释技术债排查。限制是仅提供建议、不修改代码;具体安装命令、收费与平台信息暂未提供。