技能详情(站内镜像,无评论)
作者:antonia huang @antonia-sz
许可证:MIT-0
MIT-0 ·免费使用、修改和重新分发。无需归因。
版本:v1.0.0
统计:⭐ 0 · 131 · 1 current installs · 1 all-time installs
⭐ 0
安装量(当前) 1
🛡 VirusTotal :良性 · OpenClaw :可疑
Package:antonia-sz/auto-doc-ai
安全扫描(ClawHub)
- VirusTotal :良性
- OpenClaw :可疑
OpenClaw 评估
The skill's description claims a CLI/tool that parses Python with AST and an LLM, but the package contains no code or install instructions — the instructions reference a /generate-docs binary that doesn't exist in this bundle, which is inconsistent and needs clarification before use.
目的
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.
说明范围
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.
安装机制
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.
证书
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.
持久
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.
安装(复制给龙虾 AI)
将下方整段复制到龙虾中文库对话中,由龙虾按 SKILL.md 完成安装。
请把本段交给龙虾中文库(龙虾 AI)执行:为本机安装 OpenClaw 技能「Auto Doc AI」。简介:基于 AST 和 LLM 自动生成 Python 代码文档(Google Style docstring)。 自动分析代码结构,生成符合 Google Sty…。
请 fetch 以下地址读取 SKILL.md 并按文档完成安装:https://raw.githubusercontent.com/openclaw/skills/refs/heads/main/skills/antonia-sz/auto-doc-ai/SKILL.md
(来源:yingzhi8.cn 技能库)
SKILL.md
---
name: auto-doc-ai
displayName: Auto Doc AI — 智能代码文档生成器
description: >
基于 AST 和 LLM 自动生成 Python 代码文档(Google Style docstring)。
自动分析代码结构,生成符合 Google Style 的 docstring。
author: antonia-sz
version: 1.0.0
tags: [python, documentation, codegen, developer-tools, ai]
---
# Auto Doc AI — 智能代码文档生成器
自动分析 Python 代码结构,生成符合 Google Style 的 docstring 文档。
## 功能特性
- 🔍 基于 AST 解析代码结构
- 🤖 智能函数/类/方法分析
- 📝 生成 Google Style docstring
- 📁 支持单文件或整个目录批量处理
- 🔄 支持增量更新(跳过已有文档的函数)
## 使用方法
### 为单个文件生成文档
```bash
/generate-docs /path/to/your_script.py
```
### 为整个目录生成文档
```bash
/generate-docs /path/to/src/ --recursive
```
### 强制更新已有文档
```bash
/generate-docs /path/to/src/ --overwrite
```
### 预览模式(不写入文件)
```bash
/generate-docs /path/to/your_script.py --dry-run
```
## 生成的文档格式示例
```python
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