源自 GitHub代码注释与接口文档生成
该功能面向软件开发场景，能够自动识别 Python、TypeScript 等主流语言的代码结构与 Web 框架。用户提供未充分注释的源码或接口定义后，它会遵循 Google、NumPy 或 JSDoc 等行业标准补充参数说明、异常处理与调用示例，并能导出 OpenAPI 规范及文档站点骨架。所有嵌入示例都会进行编译或运行验证，确保技术文档精准可用并生成覆盖率报告。
常见场景
它能帮你做什么？
01
补全函数级行内注释：扫描项目内缺失注释的公共类与函数，遵循指定注释规范补充参数说明、返回值、异常定义及验证可跑通的示例代码。
02
生成OpenAPI接口契约：根据 FastAPI、Express 等服务路由逻辑，自动提取请求载荷与响应结构，导出符合 OpenAPI 3.1 标准的规范文件。
03
搭建多语言文档站点：为开源工具或 SDK 自动规划 VitePress、Docusaurus 目录架构，编写从新手入门到故障排查的完整指南。
三步完成
怎么使用
1安装 Skill
把右侧安装请求发给你的 AI。
2说清楚目标
告诉 AI 你想完成什么，或直接贴入内容。
3检查结果
按需要继续调整语气、范围或格式。
复制就能用
你可以直接这样说
“请帮这个 Python 数据处理模块的所有公共函数添加 Google 风格的 docstring，并用 doctest 校验示例代码。”
“基于现有的 Express 路由与控制器代码，逆向生成符合 OpenAPI 3.1 规范的 swagger.yaml 文档。”
“将仓库中未注释的 TypeScript 接口补充 JSDoc 标注，并输出一份文档覆盖率统计报告。”
适用人群
适合谁？
上手门槛
使用难度
进阶
需要了解任务流程，页面已整理好使用步骤。
兼容范围
支持哪些 AI？
Codex可直接使用
Claude Code可直接使用
OpenClaw可直接使用
Hermes Agent可直接使用国内 Agent可直接使用
中文用户增强
Skill Px 做了什么？
中文说明简化使用方式补充中文案例整理安装流程降低理解难度
