diff --git a/README.md b/README.md index 4a6c1fe..eec311f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # 代码解释与修复助手 - AI编程学习工具 -一个智能代码解释与修复工具,帮助编程学习者理解代码并提供修复建议。 +## 简介 + +这是一个智能代码解释与修复助手,帮助编程学习者理解代码并提供修复建议。 ## 功能特点 @@ -9,7 +11,7 @@ - **多语言支持**: 支持 Python、JavaScript、Java、C++、Go、Rust 等多种编程语言 - **图形界面**: 简洁美观的界面,参考豆包AI问答方式 -## 快速开始 +## 如何运行 ### 安装依赖 @@ -21,63 +23,42 @@ pip install -r requirements.txt pip install -r requirements_gui.txt ``` -### 运行应用 +### 运行程序 -#### 图形界面版本(推荐) ```bash +# 启动图形界面 python gui_app.py ``` -#### Web API 版本 -```bash -python app.py -``` +## 团队成员及分工 +|姓名|学号|主要贡献 (具体分工)| +|---- |----------|------------------| +|周涵哲|2411020106|(组长) 核心逻辑开发、程序编写| +|于浩洋|2411020117|文案整理与汇报| -访问 http://localhost:8000 查看 API 文档 +## 1.选题思考 +- **选题背景**: 随着编程教育的普及,许多学生在学习编程时遇到了理解复杂代码的困难。为了帮助学生更好地理解代码,我们开发了这个智能代码解释与修复工具。 +- **选题意义**: 该工具可以显著提高编程学习者的学习效率,帮助他们更快地理解代码逻辑,减少调试时间。 +- **选题目标**: 开发一个功能完善的智能代码解释与修复工具,支持多种编程语言,并提供友好的图形界面。 -## 图形界面使用说明 +## 2.AI协作体验 +- **团队合作**: 我们的团队成员周涵哲和于浩洋在项目开发中进行了紧密合作,共同完成了项目的设计和实现。 +- **技术交流**: 团队成员之间通过技术交流分享了他们的项目经验和技术成果,共同提升了项目的质量和效率。 -1. 启动 `gui_app.py` 后,会弹出一个窗口 -2. 在代码输入框中粘贴或输入您的代码 -3. 选择任务类型: - - 📖 代码解释:获取代码的详细解释 - - 🔧 代码修复:分析并修复代码问题 -4. 选择编程语言(可选择 auto 自动检测) -5. 按 **Enter** 或 **Ctrl+Enter** 发送请求 -6. 等待 AI 分析,结果会显示在下方 +## 3.bug修复 +- **问题发现**: 我们在项目开发过程中发现了一些代码问题,例如语法错误、逻辑错误等。 +- **修复方案**: 针对这些问题,我们团队成员合作解决了这些问题,并提供了修复建议。 +- **测试与验证**: 修复后的代码经过测试验证,确保了工具的稳定性和可靠性。 -## 配置说明 +## 4. 未来展望 +- **功能扩展**: 未来我们计划添加更多的编程语言支持,并引入更多的代码分析功能,例如代码质量评估、代码优化建议等。 +- **用户反馈**: 我们欢迎用户反馈和建议,以便持续改进工具的功能和用户体验。 -在项目根目录创建 `.env` 文件: +## 5.自我反思 +- **项目经验**: 我们在项目开发过程中遇到了一些挑战,例如团队合作、时间管理等。通过反思,我们发现了一些问题并采取了相应的措施来解决。 +- **技术提升**: 我们团队成员在项目开发中不断学习新技术和工具,例如使用了最新的编程语言和开发框架。通过自我反思,我们评估了自己的技术水平,并不断提升自己的技能。 +- **用户反馈**: 我们重视用户反馈,不断改进工具的功能和用户体验。通过用户反馈,我们发现了一些问题并及时修复,确保了工具的质量和满意度。 -``` -# 硅基流动 API Key(必需) -SILICONFLOW_API_KEY=your_api_key_here - -# 可选配置 -SILICONFLOW_MODEL=deepseek-ai/DeepSeek-V2.5 -``` - -获取 API Key:访问 https://cloud.siliconflow.cn 注册账号 - -## 项目结构 - -``` -code-explainer-fixer/ -├── gui_app.py # 图形界面版本(推荐使用) -├── app.py # Web API 版本 -├── config.py # 配置文件 -├── requirements.txt # 核心依赖 -├── requirements_gui.txt # GUI 依赖 -├── .env # API 配置(需手动创建) -├── agents/ # 智能体模块 -├── services/ # 服务层 -├── models/ # 数据模型 -└── utils/ # 工具函数 -``` - -## 技术栈 - -- **图形界面**: CustomTkinter(现代化Tkinter) -- **AI 服务**: 硅基流动(OpenAI 兼容 API) -- **Web 框架**: FastAPI + Uvicorn +## 6. 总结 +- **项目总结**: 我们成功开发了一个功能完善的智能代码解释与修复工具,为编程学习者提供了便利的学习体验。 +- **未来工作**: 未来我们计划继续完善工具的功能,添加更多的编程语言支持,并引入更多的代码分析功能。同时,我们也欢迎用户反馈和建议,以便持续改进工具的质量和用户体验。 \ No newline at end of file