https://github.com/iuroc/code2doc
通过阅读代码，自动生成文档
https://github.com/iuroc/code2doc
ai chatgpt doc openai
Last synced: over 1 year ago
JSON representation
通过阅读代码，自动生成文档
- Host: GitHub
- URL: https://github.com/iuroc/code2doc
- Owner: iuroc
- Created: 2023-04-19T19:10:22.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-27T11:07:22.000Z (over 3 years ago)
- Last Synced: 2025-04-05T04:11:57.178Z (over 1 year ago)
- Topics: ai, chatgpt, doc, openai
- Language: Python
- Homepage:
- Size: 41 KB
- Stars: 13
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AI 软件说明文档生成
> 通过阅读代码，自动生成文档
- 作者：欧阳鹏
- 开发日期：2023 年 4 月 20 日
## 使用方法
1. 将 `.env.example` 复制到 `.env`，填写 OpenAI 的 API KEY
2. 将源代码下载到 `code` 文件夹中（文件结构无所谓，程序自动遍历读取）
3. 将事先准备的文档大纲，放入 `tasks` 文件中（已自带，可修改），一行一个任务
4. 运行 `main.py` 等待文档编写完成