AI一键注释代码、阅读整个项目、转换编程语言。已开源！

获取github源码地址和国内url、key方式：在文章底部

大家好今天给大家介绍一款开源项目，这个项目是由渡码维护的，这个项目支持自己的大模型和使用openai两种方式，本文章介绍使用openai的方式！

使用过程中发现两个问题需要注意

1、源码还不足以支撑大型项目的代码注释、阅读

2、代码不可以以gbk方式存储

当然对于我们阅读一些小型项目足够了，下面是开源项目的环境配置和使用演示。

1、环境搭建

1.1 首先要有python环境

python3.10以上版本

1.2 执行下面命令安装依赖包

pip install -r requirements.txt

依赖库安装完成

1.3 修改配置文件

源代码中是通过配置文件修改配置项 ,但是我修改了几次没有改成功，索性直接不用配置文件在python修改了配置项。

如果你修改配置文件也无法运行的话可以使用下面方法修改Python代码

国内用户：

OPENAI_BASE_URL和OPENAI_API_KEY获取方式在文章底部

有魔法的用户：

OPENAI_BASE_URL统一为：https://api.openai.com/v1

使用自己openai账户的key：https://platform.openai.com/api-keys

1.4 运行代码

python main.py

2、工具使用演示

根据工具提示的网址和端口号，复制到浏览器打开。

2.1 选择大模型

2.2 阅读代码

选中一个文件，会对这个文件进行总结

 2.3总结整个项目

2.4 为项目添加注释

首先需要选中一个文件 

点击添加注释

注释添加完成（如果对于注释不满意可以多点几次添加注释）

3、注意事项

1. 关于模型选择，3.5和4.0都可以，我在视频演示用的是3.5(gpt-3.5-turbo-1106)
2. 模型上下文最好在 16k 以上，因为有些源文件比较大，上下文太小可能长度不够
3. 把非源代码的文件删掉，如：压缩文件、图片、模型权重等。阅读这些文件无意义，可能产生不必要的报错，甚至浪费你的api额度
4. 关注你的api额度，一上来尽量不要读文件多、文件大的项目，建议先用小项目试试，关注一下api额度消耗情况。