Auto Doc AI

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

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

功能特性 🔍 基于 AST 解析代码结构 🤖 智能函数/类/方法分析 📝 生成 Google Style docstring 📁 支持单文件或整个目录批量处理 🔄 支持增量更新（跳过已有文档的函数） 使用方法 为单个文件生成文档 /生成-docs /path/to/your_script.py

为整个目录生成文档 /生成-docs /path/to/src/ --recursive

强制更新已有文档 /生成-docs /path/to/src/ --overwrite

预览模式（不写入文件） /生成-docs /path/to/your_script.py --dry-运行

生成的文档格式示例 def process_data(data, threshold=0.5): """处理输入数据并返回过滤后的结果。

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

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

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

注意事项 仅支持 Python 3.7+ 的文件 建议先使用 --dry-运行 预览生成的文档 使用 --overwrite 会替换所有现有 docstring