← 返回 Skills 市场

Auto Doc AI

Name: Auto Doc AI
Author: antonia-sz

作者 antonia huang · GitHub ↗ · v1.0.0 · MIT-0

cross-platform ⚠ suspicious

297

总下载

当前安装

版本数

在 OpenClaw 中安装

/install auto-doc-ai

功能描述

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

使用说明 (SKILL.md)

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

安全使用建议

This skill's description and docs describe a CLI (/generate-docs) and reference a GitHub repo, but the published package contains only README and SKILL.md — no code, no installer, and no declared LLM credentials. Before installing or enabling this skill: 1) ask the publisher for the implementation/source or a valid install spec (so you know what will be executed); 2) if you plan to let it run on your codebase, prefer dry-run/preview first and avoid --overwrite until you verify output; 3) confirm whether an external LLM/API key is required and where secrets would be stored; 4) if you don't trust the source, do not run arbitrary binaries or git clones suggested by the README. Clarifying these points would reduce the current uncertainty.

功能分析

Type: OpenClaw Skill Name: auto-doc-ai Version: 1.0.0 The skill bundle contains documentation (SKILL.md, README.md) and metadata (_meta.json) for a Python docstring generator. The described functionality—parsing code via AST and generating Google-style documentation—is consistent with its stated purpose. No executable code was provided in the snippet, and the instructions for the AI agent contain no evidence of prompt injection, data exfiltration, or malicious intent.

能力评估

ℹ Purpose & Capability

The stated purpose (generate Google-style docstrings from Python using AST + LLM) is reasonable and coherent as a concept, but the SKILL.md and README both reference a /generate-docs CLI and a git repo with a binary. The registry entry contains no code files or install spec, so the claimed executable/tool is not actually provided.

ℹ Instruction Scope

The runtime instructions tell the agent/user to run /generate-docs against local files or directories (including --overwrite). Operating on local source files is within the stated purpose, but instructions assume a local executable and don't describe how the LLM integration is performed or where any required API keys would come from.

⚠ Install Mechanism

There is no install spec in the registry package. README suggests installing from a GitHub repo or via clawhub, implying that additional code/binaries exist upstream — but those are not included here. This mismatch increases uncertainty: the skill may rely on an external binary that won't be present unless the user manually installs it.

ℹ Credentials

The skill declares no environment variables or credentials, which is proportional if it intends to use the agent's internal model. However the description explicitly mentions an LLM; if the implementation calls an external LLM API it would normally require API keys (not declared). This absence should be clarified.

✓ Persistence & Privilege

The skill is not marked always:true, and is user-invocable. It does not request persistent privileges or system-wide config changes in the provided files.

如何使用

确保已安装 OpenClaw（本地或 Docker 部署）
在对话框中输入安装命令：/install auto-doc-ai
安装完成后，直接呼叫该 Skill 的名称或使用 /auto-doc-ai 触发
根据 Skill 的参数说明提供必要输入，即可获得结构化输出

版本历史

v1.0.0

Initial release of Auto Doc AI — 智能代码文档生成器. - 自动分析 Python 代码结构，基于 AST 和 LLM 生成 Google Style docstring - 支持单文件、目录和递归批量处理 - 可选择仅处理缺失文档或强制覆盖全部 docstring - 支持预览模式（dry-run）避免直接修改文件 - 仅支持 Python 3.7 及以上版本

元数据

Slug auto-doc-ai

版本 1.0.0

许可证 MIT-0

累计安装 1

当前安装数 1

历史版本数 1

常见问题

Auto Doc AI 是什么？

基于 AST 和 LLM 自动生成 Python 代码文档（Google Style docstring）。自动分析代码结构，生成符合 Google Style 的 docstring。它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 297 次。

如何安装 Auto Doc AI？

在 OpenClaw 或 Claude Code 对话框中运行命令「/install auto-doc-ai」即可一键安装，无需额外配置。

Auto Doc AI 是免费的吗？

是的，Auto Doc AI 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。

Auto Doc AI 支持哪些平台？

Auto Doc AI 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。

谁开发了 Auto Doc AI？

由 antonia huang（@antonia-sz）开发并维护，当前版本 v1.0.0。