AutoDoc-ChatGPT - 基于ChatGPT的自动编程文档生成器

项目介绍：AutoDoc-ChatGPT

AutoDoc-ChatGPT 是一个用于自动生成编程语言文档的 Python 脚本，利用了 ChatGPT 模型的强大功能。该工具能够帮助开发者为任意代码库生成详细的文档说明。用户只需提供需要生成文档的文件路径，AutoDoc-ChatGPT 就可以用自然语言描述文件的功能、参数以及返回值。

起步指南

安装步骤

将项目克隆到本地机器：

git clone https://github.com/awekrx/AutoDoc-ChatGPT.git

安装所需的依赖包：
```
pip install -r requirements.txt
```

支持的编程语言

AutoDoc-ChatGPT 当前支持的编程语言包括：

Python
JavaScript
TypeScript

虽然项目支持这些编程语言，但 TypeScript 和 JavaScript 存在一些已知的错误，因为项目仍在测试中。另外，若文件中存在两个或多个类而且这些类中有方法同名，也会出现错误。

使用方法

编辑配置文件

打开 config.ini，如果没有使用 OAuth 认证，则在其中添加 email 和 password。如果使用 OAuth 认证，则需打开 ChatGPT 获取 __Secure-next-auth.session-token 的 cookie，并将其写入 session-token。

启动

运行以下命令开始生成文档：

py main.py -file "文件路径"

文件路径可以是相对路径或绝对路径。执行后，在文件所在的目录中会生成一个后缀为 _commented.language 的文件。

使用示例

这里有一个工具使用的直观预览图片（在实际使用中会有相关图示帮助理解）。

作为函数使用

AutoDoc-ChatGPT 还可以作为 Python 函数来使用，示例如下：

from modules.autodoc import AutoDoc
import configparser

config = configparser.ConfigParser()
config.read("config.ini")

auth = {
    "email": config["ChatGPT"]["email"],
    "password": config["ChatGPT"]["password"],
    "session_token": config["ChatGPT"]["session_token"]
}

result = AutoDoc(
        auth,
        "需要生成注释的代码",
        "语言代码",
        "可选的注释模型"
    ).start()
print(result)
# 输出：带有注释的代码

注意事项

AutoDoc-ChatGPT 在某些情况下生成的注释可能不完全准确，因此建议生成的注释作为初稿使用，可能需要进行编辑修改。

授权许可

本项目采用 MIT 许可协议授权。

致谢

特别感谢人工智能的发展以及 ChatGPT 的支持，此外，还要感谢 acheong08 创建的 ChatGPT 项目。