借助 LLM 理解 C/C++项目，为项目中的每个源代码文件生成文档
- 为 C/C++项目生成 AST
- 基于 AST 解析源代码文件中包含的类与函数，并生成 Function/Class CallGraph
- 按 Function CallGraph 的逆拓扑排序，为各个函数生成文档
- 按 Class CallGraph 的逆拓扑排序，为各个类生成文档
- 基于函数文档生成模块文档
- 基于模块文档生成仓库文档
├── docker # docker封装的项目demo
│ ├── cmd.dockerfile # main.py的docker运行环境，命令行执行工具
│ └── service.dockerfile # service.py的docker运行环境，启动服务端
├── lib # 项目依赖的库，主要包含Vanguard-V2-StaticChecker的编译产物
│ └── cge
├── Vanguard-V2-StaticChecker # C/C++项目静态分析工具
│ └── docker # docker封装的Vanguard，可以参考其中脚本解析C/C++项目，获得中间文件
├── 'resource' # 待分析C/C++项目源代码目录(运行时生成)
│ └── vanguard
├── 'docs' # 生成的文档目录(运行时生成)
├── 'output' # C/C++项目分析中间产物目录(运行时生成)
├── metrics # 各个度量指标实现
│ ├── clazz.py # 类级别度量
│ ├── doc.py # 度量结果文档对象
│ ├── function.py # 函数级别度量
│ ├── function_v2.py # 函数级别度量（V2）
│ ├── metric.py # 度量基类及上下文
│ ├── module.py # 模块级别度量
│ ├── module_v2.py # 模块级别度量（V2）
│ ├── parser.py # 软件解析
│ ├── repo.py # 仓库级别度量
│ ├── repo_v2.py # 仓库级别度量（V2）
│ └── structure.py # 目录结构度量
├── utils
│ ├── ast_generator.py # C/C++项目生成AST
│ ├── file_helper.py # 压缩文件工具类库
│ ├── llm_helper.py # LLM工具类库
│ ├── multi_task_dispatch.py # 多线程任务分发器
│ ├── settings.py # 配置工具类库
│ └── strings.py # 字符串工具类库
├── .env # 配置文件/环境变量
├── main.py # 命令行入口
├── service.py # web服务入口
├── requirements.txt # Python依赖管理
└── README.md
- 项目基于 OpenAI 协议调用 LLM，需在.env 中设置调用的 LLM 服务的域名
OPENAI_BASE_URL、模型MODEL、温度MODEL_TEMPERATURE、输出语言MODEL_LANGUAGE，并配置OPENAI_API_KEY作为密钥。默认采用阿里百炼的 qwen-plus。 - 目前提供了 docker/cmd.dockerfile，可以对测试项目 md5 进行一次完整的分析。本地运行依赖可参考该 dockerfile。
- RepoMetricV2 使用到 HuggingFace 拉取远端模型，若网络不佳，可在.env 中设置
HF_ENDPOINT=https://hf-mirror.com。 - 由于不同 C/C++项目的编译方式不同，目前需要根据项目特征手动设置合适的命令以生成 AST。
- 在.env 中设置
LOG_LEVEL可以控制日志的输出级别，默认DEBUG级别。
- 提高文档质量，增加对生成结果准确性的评估
- 增加对其他语言的支持：RUST、Java、JavaScript