auto-doc-ai

基于 AST 和 LLM 自动生成 Python 代码文档(Google Style docstring)。 自动分析代码结构,生成符合 Google Style 的 docstring。

Safety Notice

This listing is from the official public ClawHub registry. Review SKILL.md and referenced scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "auto-doc-ai" with this command: npx skills add antonia-sz/auto-doc-ai

Auto Doc AI — 智能代码文档生成器

自动分析 Python 代码结构,生成符合 Google Style 的 docstring 文档。

功能特性

  • 🔍 基于 AST 解析代码结构
  • 🤖 智能函数/类/方法分析
  • 📝 生成 Google Style docstring
  • 📁 支持单文件或整个目录批量处理
  • 🔄 支持增量更新(跳过已有文档的函数)

使用方法

为单个文件生成文档

/generate-docs /path/to/your_script.py

为整个目录生成文档

/generate-docs /path/to/src/ --recursive

强制更新已有文档

/generate-docs /path/to/src/ --overwrite

预览模式(不写入文件)

/generate-docs /path/to/your_script.py --dry-run

生成的文档格式示例

def process_data(data, threshold=0.5):
    """处理输入数据并返回过滤后的结果。

    Args:
        data (list): 输入数据列表。
        threshold (float, optional): 过滤阈值,默认为 0.5。

    Returns:
        list: 过滤后的数据列表。

    Raises:
        ValueError: 如果数据格式无效。
    """
    pass

注意事项

  • 仅支持 Python 3.7+ 的文件
  • 建议先使用 --dry-run 预览生成的文档
  • 使用 --overwrite 会替换所有现有 docstring

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Coding

InStreet gomoku AI

InStreet五子棋AI。在InStreet桌游室进行五子棋对局时,自动计算最佳落子并提交。支持威胁检测,优先防守对手的活三/冲四。

Registry SourceRecently Updated
2540Profile unavailable
Coding

一个智能的业务需求转研发文档工具。AI 自主分析项目代码库,理解业务需求,参考实际代码,生成可直接执行的研发文档。支持任意技术栈,无需配置。

Smart business-to-dev requirement translator. AI first analyzes and memorizes project structure, then understands business requirements, references actual co...

Registry SourceRecently Updated
2691Profile unavailable
Coding

Fundraising Advisor

Professional fundraising advisory skill for startups - AI-powered project assessment, pitch deck generation, valuation analysis, investor matching, and PDF p...

Registry SourceRecently Updated
3510Profile unavailable
Coding

Openclaw

Bookmark intelligence for developers. Browse, search, triage, and manage your AI-analyzed library. Submit URLs, assign projects, trigger deep analysis, and e...

Registry SourceRecently Updated
4380Profile unavailable