Lluminy 是一款面向 Python 项目的 AI 文档自动化工具,核心用途是自动生成 docstring(文档字符串),帮助开发者减少编写文档的时间,专注于功能开发。
主要能力:
- 自动为 Python 代码库生成 docstring,可在几分钟内完成整个项目的文档生成。
- 算法仅操作 docstring,不修改原始代码,以避免因大语言模型幻觉而改动代码逻辑。
- 支持处理多个文件甚至整个项目。
- 可选择为所有函数生成文档,或仅为缺失 docstring 的函数补充文档。
- 与 GitHub 集成,可连接 GitHub 账户并选择仓库(支持个人和组织仓库),选择特定 Python 文件、目录或整个分支,生成结果后创建拉取请求,无需手动复制粘贴代码。
- GitHub Bot 正在开发中,未来将持续扫描拉取请求并提供代码注释建议。
使用方式:
- 连接 GitHub 账户。
- 选择需要生成文档的仓库。
- 选择要文档化的 Python 文件、目录或分支。
- 自定义输出:为所有函数或仅缺失 docstring 的函数生成。
- 点击生成,Lluminy 为整个代码库生成 docstring,并创建拉取请求以合并结果。
适用场景:
- 小型业余项目:提供有限的 AI token 使用量,docstring 生成由 LLama3.3 驱动,支持文档全部函数或填补缺失。
- 团队与生产代码库:提供每月 1000 万 AI token 限额,以及优先支持。
限制:
- 目前主要面向 Python 项目。
- GitHub Bot 尚未发布,处于开发中。
- 具体定价、免费额度细节、平台支持范围等暂未提供。