iuroc / code2doc Public

Notifications You must be signed in to change notification settings
Fork 4
Star 13

通过阅读代码，自动生成文档

13 stars 4 forks Branches Tags Activity

Name		Name	Last commit message	Last commit date
Latest commit History 8 Commits
.env.example		.env.example
.gitignore		.gitignore
README.md		README.md
chat.py		chat.py
main.py		main.py
main_msg.py		main_msg.py
tasks		tasks
util.py		util.py

Repository files navigation

AI 软件说明文档生成

通过阅读代码，自动生成文档

作者：欧阳鹏
开发日期：2023 年 4 月 20 日

使用方法

将 .env.example 复制到 .env，填写 OpenAI 的 API KEY
将源代码下载到 code 文件夹中（文件结构无所谓，程序自动遍历读取）
将事先准备的文档大纲，放入 tasks 文件中（已自带，可修改），一行一个任务
运行 main.py 等待文档编写完成