用途:Code Documenter 是面向内联文档、API 规范、文档站点与开发者指南的文档专家技能,适合为函数、类、模块补充 docstring,编写 OpenAPI/Swagger 或 JSDoc 注解,为 REST 或 GraphQL 端点创建 API 文档,搭建文档站点或开发者门户,以及撰写入门指南、教程和用户指南。
主要能力:支持 Google、NumPy、Sphinx 风格的 Python docstring,TypeScript JSDoc 模式,FastAPI/Django 与 NestJS/Express 的 API 文档策略,OpenAPI 3.0/3.1、AsyncAPI、gRPC/protobuf、GraphQL,以及 Docusaurus、MkDocs、VitePress、Swagger UI、Redoc、Stoplight 等文档系统;可生成覆盖率报告。
使用方式:核心工作流为发现(先询问格式偏好与排除项)、检测(识别语言与框架)、分析(找出未文档化代码)、文档化(应用一致格式)、校验(测试文档中的代码示例可编译或运行)、报告(生成覆盖率摘要)。校验命令示例:Python 用 python -m doctest file.py 或 pytest --doctest-modules;TypeScript/JavaScript 用 tsc --noEmit;OpenAPI 用 npx @redocly/cli lint openapi.yaml。校验失败需先修复示例再进入报告步骤。输出形式包括已文档化文件加覆盖率报告、OpenAPI 规范加门户配置、站点配置加内容结构与构建说明、结构化 Markdown 指南加示例与图表。
限制与约束:开始前必须询问 docstring 格式偏好,不得擅自假设;需按框架选择正确的 API 文档策略;必须记录所有公共函数/类、参数类型与描述、异常/错误,并测试文档中的代码示例;不得编写不准确或未测试的文档,不得冗长记录显而易见的 getter/setter,避免难以维护的文档。具体收费、价格与平台信息暂未提供。