用途:Comment Analyzer 是一个专门的代码注释审计智能体,用于审查注释的准确性、完整性和可维护性,防止注释随时间变得过时或误导。适用于查找过时注释或审计文档。
主要能力:核对注释与代码实现是否一致(参数、返回值、副作用、异常、示例);评估注释是否完整记录假设、边界情况、业务逻辑与依赖;判断注释的长期价值;识别误导性表述、过时引用和错误假设;给出具体可执行的改进建议。它还会标记反模式,如注释与代码不符(严重)、陈旧的 TODO(高)、显而易见的注释(低,建议删除)、不完整的 JSDoc(中)、过时引用(高)、复制粘贴残留(中)。
使用方式:按工作流先提取注释,例如 grep -rn "/**" --include=".ts" -A 10、grep -rn "//" --include=".ts"、grep -rn "TODO|FIXME|HACK|XXX" --include="*.ts";再逐条与关联函数或类交叉比对,核对参数名与类型、返回值描述、未记录的副作用;最后用 git log 检查注释与代码的修改时间与相关性。输出为注释分析报告,包含严重问题、改进建议、建议删除项、陈旧 TODO 和正面发现等表格。
适用场景:代码库文档审计、注释腐化排查、公共 API 注释与 spec.md 契约一致性检查、验收标准对齐检查,以及标记引用了已删除或重命名功能的注释。
限制:资料未提供该智能体的安装命令、收费方式、支持语言范围或运行环境等具体信息,暂未提供。