SuperAPI AI 工具集

code-documenter

办公与效率

查看项目

更新于 10-16 00:23

技能介绍

用途:Code Documenter 是 megastep/codex-skills 中的文档专家技能,适用于为函数和类添加 docstring、创建 API 文档、生成文档覆盖率报告、搭建文档站点以及编写入门指南与教程。可通过自然语言请求触发,示例中使用 $code-documenter 作为命令式标签。

主要能力:支持语言特定的 docstring 格式(Google、NumPy、Sphinx 风格)、TypeScript JSDoc、OpenAPI/Swagger 规范、交互式 API 门户(Swagger UI、Redoc、Stoplight)、静态站点生成(Docusaurus、MkDocs、VitePress),以及多协议 API 文档(REST、GraphQL、WebSocket、gRPC)。可针对 FastAPI、Django、NestJS、Express 等框架采用对应文档策略,并生成覆盖率指标。

使用方式:核心工作流为发现(询问格式偏好与排除项)、检测(识别语言与框架)、分析(查找未文档化代码)、文档化(应用一致格式)、报告(生成覆盖率摘要)。大型仓库可借助 Codex 多智能体委派(spawn_agent + wait)并行执行发现与文档化。

限制:开始前必须询问 docstring 格式偏好,不得假设格式;需检测框架以选择正确的 API 文档策略;不得编写不准确或未测试的文档;需记录异常与错误;避免冗长记录显而易见的 getter/setter。参考目录中的命令与配置片段仅作示例,除非明确要求执行;破坏性或影响生产的操作需显式确认。具体安装命令、收费与平台信息暂未提供。