AI 代码助手 - Code Analysis Helper

项目介绍

AI 代码助手是一款旨在帮助开发者更加高效地分析项目源码的智能工具。通过结合 AI 的强大能力，它能够大幅减少繁琐的手动阅读工作，提升理解大型项目的速度和准确性。工具特别适用于处理规模庞大的代码库，并为开发者提供自动化的代码结构分析与智能问答支持。

开发初衷

日常开发工作中，阅读和理解源码往往是不可避免的任务。尤其是当开发者接手一个新项目或者调试复杂系统时，通常需要从零开始研究项目的架构、逻辑和依赖项。然而，对于几十万行代码的项目，手动分析常常令人望而生畏。为了简化这一过程，我们开发了这款 AI 代码助手，帮助开发者快速浏览和理解项目的框架和设计理念。

核心功能

1. 源码分析

该功能帮助开发者自动分析项目源码，生成有价值的代码摘要，快速掌握项目的框架和依赖。

工作原理

遍历源码：自动定位项目中每个文件，确保全面覆盖所有细节。
代码分析：AI 结合语义理解与语法树解析，生成每个文件的功能、接口、类和依赖关系的简要摘要。
生成文档：自动生成汇总文档 all.md，帮助开发者快速了解项目结构，无需手动维护技术文档。

2. 代码问答

AI 代码助手还支持通过自然语言提问来解答与源码相关的问题。

功能描述

问题生成：工具会结合用户问题与项目上下文信息，生成合适的 prompt。
智能检索：通过分析问题，AI 会检索相关源码文件，结合上下文提供详细解释。
深度分析：AI 结合代码逻辑与文件内容，给出技术解答，帮助开发者理解复杂实现。

3. 提示模板

为提高代码分析的准确性，AI 代码助手使用一套自定义的提示模板，引导 AI 进行结构化分析。输出以 YAML 格式展示，便于后续解析和处理。

使用说明

克隆项目：

git clone https://github.com/<username>/code-analysis.git

安装依赖：
```
go mod tidy
```

运行 AI 代码助手：

 go run entry/main.go analyze  -d /home/gw123/go/src/github.com/mytoolzone/task-mini-program  -t sk-xx -o /home/gw123/go/src/github.com/mytoolzone/task-mini-program/result

 go run entry/main.go question 请帮我分析一下这个项目主要是干什么的 -t sk-xxx -s /home/gw123/go/src/github.com/mytoolzone/task-mini-program/result/all.md

示例

代码结构分析：
- 自动生成的 all.md 文件将为你提供项目的摘要，包括项目中所有文件的结构、类、接口、方法等关键信息。
智能问答：
- 通过 AI 的智能分析，快速获得项目中某段代码的功能解释或特定模块的实现逻辑，提升开发效率。

贡献

欢迎提交 issue 或发起 pull request，一起完善和优化该工具。

许可证

本项目基于 MIT License 开源。

你可以根据需要修改和补充此 README，确保所有项目细节都清晰呈现。

gw123/code-analysis