SuperAPI AI 工具集

code-documenter

编程与开发

查看项目

更新于 10-16 00:22

技能介绍

用途:处理代码文档、API 规范与开发者指南类任务。核心工作流为:先询问格式偏好与排除项,检测语言和框架,定位未文档化代码,按统一格式撰写,再校验示例可用性,最后生成覆盖率报告。

主要能力:生成并校验 Google、NumPy、Sphinx 风格 Python docstring,JSDoc 注解,OpenAPI 3.0/3.1 等 API 规范,文档站点配置,以及包含示例和图表的用户指南与教程。内置参考覆盖 FastAPI、Django、NestJS、Express、GraphQL 等,以及 Docusaurus、MkDocs、VitePress、Swagger UI、Redoc、Stoplight 等工具。

必要用法:按任务类型输出文档文件与覆盖率报告、OpenAPI 规范与门户配置、站点配置与构建说明或结构化 Markdown。校验命令示例:Python 用 python -m doctest file.py 或 pytest --doctest-modules;TypeScript/JavaScript 用 tsc --noEmit;OpenAPI 用 npx @redocly/cli lint openapi.yaml。校验失败应先修复并重新校验。作为 AIX Pack 技能,用户可通过别名 aix-code-documenter 调用,生成物写入 .aix/ 目录(需先执行 mkdir -p .aix),默认可能被覆盖,除非明确要求否则不写入项目根目录。

限制:开始前必须询问格式偏好,不假设 docstring 风格;不写不准确或未测试的文档,不跳过错误说明,不为显而易见的 getter/setter 写冗长文档;具体收费与平台信息暂未提供。