AutoDoc-ChatGPT
AutoDoc-ChatGPT 是一个利用 ChatGPT 模型自动生成任何编程语言文档的 Python 脚本。
使用 AutoDoc-ChatGPT,您可以轻松生成代码库的全面文档。只需提供您希望生成文档的文件路径,AutoDoc-ChatGPT 将生成其功能、参数和返回值的详细描述,以自然语言呈现。
入门指南
安装
将此仓库克隆到本地机器:
git clone https://github.com/awekrx/AutoDoc-ChatGPT.git
然后安装所需的软件包:
pip install -r requirements.txt
支持的编程语言
- Python
- JavaScript
- TypeScript
- Go
- C#
- C++
- PHP
- Ruby
- Rust
- Java
- Kotlin
以及其他……
免责声明
: TypeScript 和 JavaScript 存在一些错误,正在测试中
免责声明_2.0
: 在有两种或更多类的方法名相同时,注释文件时会出现已知错误。
用法
编辑配置
打开 config.ini
并在其中添加 email
和 password
,如果您未使用 OAuth 授权。
否则,打开 ChatGPT 并获取 __Secure-next-auth.session-token
cookie 并将其写入 session-token
。
启动
py main.py -file "path to the file"
文件路径可以是相对路径或绝对路径。
执行后,将在目标文件所在的文件夹中创建一个 yourfilename_commented.language
文件。
或
py main.py -file "path to the file"
不推荐,测试不充分。 您可以指定一个含有注释选项的文件以创建这样的注释。
使用示例
其他用法
您也可以将其用作 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)
# 输出: 带有注释的代码
免责声明
并不总是创建正确的注释。它并不总是意味着您想要的内容。请将其作为可能需要编辑的注释草稿使用。
许可
该项目是根据 MIT 许可的。
鸣谢
非常感谢 AI 的发展,特别感谢 СhatGPT 用于生成此 Readme。