用途:在写完一个功能后,对本分支新增或修改的注释与 docstring 做一次精简审查。该技能会直接编辑文件,而不只是给出报告。
主要能力:把注释和字段 docstring 压缩到通常不超过 3 行、多数 1 行,函数与结构体 docstring 不超过 5 行;删除同义反复、对显而易见内容的叙述、重复的类型签名、代码来历说明和含糊措辞;保留代码存在的原因与坑点等真正有价值的信息;删除过长示例,公开项示例不超过 8 行且必须在测试中可运行;修正本分支导致过时的注释;Python docstring 使用 markdown 单反引号,不用 RST 双反引号。
使用方式:先用 git diff --stat origin/main...HEAD 查看改动的 crate,再用 git diff origin/main...HEAD 查看具体内容;按改动区域(一个 crate 或其他改动文件分组)分派子代理,避免遗漏 crates/ 之外的文件,然后自行复核其编辑。完成后运行 make format-rs && make lint-rs,并用 git diff --stat 确认格式化只触及自己的文件。最后按文件用几行说明删改内容,不必列出完整清单。
限制:只处理本分支新增或修改的内容,除非明确要求更大范围;不改变代码行为,若注释错误源于代码错误,应指出而非改写注释;追求简洁而非简短,难以理解的注释比长注释更糟。资料未提供安装命令、收费与平台信息。