SuperAPI AI 工具集

code-documentation

写作与研究

查看项目

更新于 10-16 01:07

技能介绍

用途:让 AI 代理分析源码,为代码库生成清晰、完整的文档,覆盖单函数文档字符串到完整项目 README,兼顾人类开发者与 IDE、文档生成工具。

主要能力:清点代码库中的公开模块、类、函数、常量与类型定义,识别缺失或过时文档;按用户需求决定生成内联文档字符串、独立 API 参考、项目 README 或组合;分析参数类型、返回类型、默认值、异常与副作用,并参考测试文件理解用法与边界情况;生成含一行摘要、扩展描述、参数与返回值说明、异常说明及至少一个用法示例的文档;将内联文档插入符号上方或内部,将独立文件写入项目根目录或 docs/;校验参数名与签名一致、引用类型存在、示例语法有效,并标记不一致处。

支持格式:Python(Google 风格、NumPy 风格、Sphinx reStructuredText)、JavaScript/TypeScript(JSDoc、TypeDoc)、Java(Javadoc)、Go(Godoc 注释约定)、Rust(/// 文档注释与 #[doc])、Ruby(YARD)、Markdown(README、CHANGELOG、ADR)。

使用方式:将代理指向文件、目录或具体符号并说明所需文档,例如“为 src/services/ 中每个公开函数添加 Google 风格文档字符串”“根据项目结构和 package.json 生成 README”“用 JSDoc 记录此类并为每个方法附示例”。代理会沿用项目现有文档风格;若未检测到约定,会询问格式或默认采用该语言最常见风格。

适用场景:为公开 API 补充文档、生成项目 README、为类与方法添加注释、维护文档与代码同步。

限制与边界:动态生成的 API(装饰器、插件系统)可能被静态分析遗漏,需提示用户并建议运行时内省或手动标注;重载或泛型函数需分别记录每个签名变体;monorepo 应生成链接各包 README 的根 README;非英文代码库需询问文档语言;敏感代码应避免写入内部 URL、凭据或业务逻辑细节。建议匹配项目现有风格、记录“为什么”而非仅“是什么”、为每个公开符号附示例、保持 README 可快速浏览、不主动记录私有内部实现、代码变更后重新生成文档。具体安装命令与收费信息暂未提供。