86 lines (62 loc) · 2.2 KB

项目目录结构说明

本文档说明整理后的项目目录结构和各文件夹的用途。

📁 整理前后对比

整理前

所有文件散落在根目录
测试文件、工具脚本混合在一起
难以找到和管理特定功能的文件

整理后

按功能分类组织文件
每个目录有明确的用途
便于查找和维护

📂 目录结构详解

🎯 核心目录

src/ - 核心源代码，主要业务逻辑
config/ - 配置文件，系统设置
data/ - 数据文件，运行时数据
logs/ - 日志文件，运行日志

🛠️ 工具目录

batch/ - 批量审查相关工具和脚本
tests/ - 所有测试和验证脚本
scripts/ - 安装、启动和管理脚本
tools/ - 实用工具、诊断和数据处理脚本

📚 文档目录

docs/ - 项目文档，使用指南

🔧 开发目录

debugTools/ - 调试工具（保持原有结构）
Tools/ - 其他工具（保持原有结构）
hooks/ - Git/SVN 钩子脚本

🚀 快速导航

我想要...

运行批量审查

→ 前往 batch/ 目录，查看 batch/README.md

测试功能

→ 前往 tests/ 目录，查看 tests/README.md

安装和部署

→ 前往 scripts/ 目录，查看 scripts/README.md

诊断问题

→ 前往 tools/ 目录，查看 tools/README.md

查看文档

→ 前往 docs/ 目录，查看 docs/README.md

修改配置

→ 前往 config/ 目录

查看日志

→ 前往 logs/ 目录

📝 使用建议

新用户

阅读 docs/README.md 了解文档结构
运行 scripts/setup_enhanced.bat 安装环境
使用 batch/simple_batch_review.py 开始批量审查

开发者

修改 src/ 目录下的核心代码
在 tests/ 目录下添加测试
使用 tools/ 目录下的诊断工具

管理员

配置 config/ 目录下的文件
使用 scripts/ 目录下的管理脚本
监控 logs/ 目录下的日志

🔗 相关文档