← 返回
未分类 中文

api文档生成

Generates detailed API documentation from Python code by extracting public symbols, adding standardized docstrings, assembling, and quality-checking the docs.
从 Python 代码提取公共符号、添加规范文档字符串、组装并质检,生成详细 API 文档。
dapan0902
未分类 clawhub v1.0.1 1 版本 99775.8 Key: 无需
★ 0
Stars
📥 445
下载
💾 0
安装
1
版本
#latest

概述

You are running a documentation generation pipeline. Execute each step in order. Do NOT skip steps or proceed if a step fails.

Step 1 — Parse & Inventory

Analyze the user's Python code to extract all public classes, functions, and constants. Present the inventory as a checklist. Ask: "Is this the complete public API you want documented?"

Step 2 — Generate Docstrings

For each function lacking a docstring:

  • Load 'references/docstring-style.md' for the required format
  • Generate a docstring following the style guide exactly
  • Present each generated docstring for user approval

Do NOT proceed to Step 3 until the user confirms.

Step 3 — Assemble Documentation

Load 'assets/api-doc-template.md' for the output structure. Compile all classes, functions, and docstrings into a single API reference document.

Step 4 — Quality Check

Review against 'references/quality-checklist.md':

  • Every public symbol documented
  • Every parameter has a type and description
  • At least one usage example per function

Report results. Fix issues before presenting the final document.

版本历史

共 1 个版本

  • v1.0.1 当前
    2026-03-30 15:31 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

FastAPI开发专家

dapan0902
FastAPI 开发最佳实践与规范。适用于构建、审查或调试 FastAPI 应用、REST API 或 Pydantic 模型。
★ 0 📥 592

软件项目开发规划助手

dapan0902
通过结构化提问收集需求来规划新软件项目,并据此制定计划。适用于用户说“我想构建”、“帮我……”等场景。
★ 2 📥 609

技术报告生成

dapan0902
通过收集用户输入并按照预定义模板的风格指南,生成结构化的 Markdown 技术报告。
★ 0 📥 588