从 Python 代码提取公共符号、添加规范文档字符串、组装并质检，生成详细 API 文档。
您正在运行一个文档生成管道
功能概述
您正在运行一个文档生成管道是一项面向实际任务的技能，主要用于请执行每个步骤；请不要跳过步骤, 或如果步骤失败则继续；
核心要点
- 步骤 1 — 解析 & 盘点；
- 分析用户的 Python 代码以进行外加。
- 它将相关步骤、工具调用和结果整理方式集中到统一流程中，帮助使用者更快完成目标并减少重复操作。
使用与执行
使用时应结合输入条件选择合适的执行方式，核对必要参数、依赖环境与输出内容，并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景，可作为自动化工作流的一部分，也便于后续检查、调整和扩展。从功能定位来看，该技能强调把分散的操作要求整理成清晰、可复用的处理流程，使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
结果检查与注意事项
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数，再依据技能说明逐步执行；若输入条件不完整，应先补齐信息或采用保守配置，避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期，并对异常提示、缺失字段和边界情况进行处理；涉及批量任务时，还应保存进度，避免中断后重复操作。
您正在运行一个文档生成流程。请按顺序执行每个步骤。不得跳过任何步骤，也不得在某一步骤失败时继续执行后续步骤。
步骤 1 — 解析与清单整理
分析用户的 Python 代码，提取所有公开的类、函数和常量。以复选框列表形式呈现该清单。并询问：“这是您希望被记录的完整公共 API 吗？”
步骤 2 — 生成 Docstring
针对每个缺少 docstring 的函数：
- 加载
references/docstring-style.md文件，获取所需的格式规范 - 严格按照该风格指南生成 docstring
- 将每个生成的 docstring 单独列出，供用户审核确认
在用户明确确认前，不得进入步骤 3。
步骤 3 — 组装文档
加载 assets/api-doc-template.md 文件，获取输出结构模板。将所有类、函数及其 docstring 汇总编译为一份完整的 API 参考文档。
步骤 4 — 质量检查
依据 references/quality-checklist.md 进行审查：
- 每个公开符号均已文档化
- 每个参数均标注了类型与描述
- 每个函数至少包含一个使用示例
报告检查结果。在向用户提交最终文档前，必须修复所有问题。
热门AI工具
相关专题
Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章，帮助读者完成上线流程。
0
2026.10.28
Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章，帮助读者完成从初始化到日常开发的配置。
0
2026.10.28
Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章，帮助读者理解各文件夹的用途与引用方式。
0
2026.10.28
本专题介绍Gradle插件开发的基本流程，涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法，帮助你理解插件如何组织构建逻辑，减少多个项目之间的重复配置。
0
2026.10.22
本专题介绍Gradle Wrapper的基本作用，涵盖文件组成、生成方法、版本配置和任务调用，帮助你理解项目如何使用指定的Gradle版本，减少不同开发环境带来的构建差异。
0
2026.10.22
本专题整理Golangci-lint常用Linters的用途与配置方法，覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查，帮助项目合理选规则。
0
2026.10.22
本专题介绍Gradle Java项目构建方法，涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查，帮助你理解各阶段的任务关系，逐步完成项目构建。
0
2026.10.22
本专题汇总PHP常见时间戳漏洞，包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等，并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案，帮助开发者快速排查和加固时间相关代码。
0
2026.10.22
本专题聚焦Golangci-lint YAML配置文件，讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置，便于团队统一检查标准。
0
2026.10.22
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.6万人学习
共6课时 | 54.7万人学习
最新文章
