SuperAPI AI 工具集

docs

写作与研究

查看项目

更新于 10-16 08:45

技能介绍

用途:检查代码是否具备合适的文档,并修复文档缺口。参数 $ARGUMENTS 可选,用于指定检查范围:commit 只检查暂存文件;pr 检查当前 PR 中变更的全部文件;all 检查整个代码库。若未提供参数:在 PR 分支上默认使用 pr,否则默认使用 commit。

主要能力与流程:第一阶段根据 $ARGUMENTS 确定范围;第二阶段分析文档,找出缺少文档的函数与类,评估现有文档质量,并从 CLAUDE.md 中提取项目文档规范;第三阶段针对发现的缺口生成符合项目约定的文档,套用对应语言的格式(如 roxygen2、docstrings、JSDoc),在 R 中使用 @inheritParams 避免重复,R 项目还可运行 devtools::document() 更新 man/ 文件;第四阶段验证文档格式合规且无失效引用;第五阶段输出报告,包含已检查文件、新增或更新的文档以及遗留问题。

使用方式:以该技能命令方式调用,并可按需附带 commit、pr、all 参数控制范围。若作为独立请求运行,在成功完成所有阶段后会自动退出。

适用场景:需要为现有代码补齐文档注释、统一文档风格或在提交与 PR 阶段核查文档完整性的开发流程。

限制:资料未说明具体支持的平台、收费、价格或运行环境要求;其实际效果取决于项目是否在 CLAUDE.md 中提供文档规范,以及所用语言是否属于其列出的格式范围。