monkeycode-ai
80b4718568
创建以下文档: - INDEX.md - 项目索引和概览 - ARCHITECTURE.md - 系统架构设计文档 - INTERFACES.md - 接口和类型定义文档 - DEVELOPER_GUIDE.md - 开发者指南 文档覆盖内容: - 项目结构和模块说明 - 技术栈和依赖 - 核心组件设计 - API 接口定义 - 数据模型 - 开发环境配置 - 代码规范 - 测试指南 - 调试技巧 - Git 工作流 Co-authored-by: monkeycode-ai <monkeycode-ai@chaitin.com>
117 lines
2.7 KiB
Markdown
117 lines
2.7 KiB
Markdown
# CodePlay 项目文档索引
|
||
|
||
## 项目概述
|
||
|
||
CodePlay 是一个代码转换工具平台，支持 C#、Java、C++ 三种编程语言之间的双向转换。平台提供 Web 界面、CLI 工具和 API 接口三种使用方式。
|
||
|
||
## 文档结构
|
||
|
||
| 文档名称 | 说明 |
|
||
|---------|------|
|
||
| [ARCHITECTURE.md](./ARCHITECTURE.md) | 系统架构设计文档 |
|
||
| [INTERFACES.md](./INTERFACES.md) | 接口和类型定义文档 |
|
||
| [DEVELOPER_GUIDE.md](./DEVELOPER_GUIDE.md) | 开发者指南 |
|
||
|
||
## 核心模块
|
||
|
||
### 1. CodePlay.Core - 核心转换引擎
|
||
|
||
[查看 Core 模块文档](./modules/CodePlay.Core.md)
|
||
|
||
**主要功能**：
|
||
- 代码解析（Parser）
|
||
- 代码转换（Converter）
|
||
- 代码生成（Generator）
|
||
- 编译验证（Validator）
|
||
|
||
**命名空间**：
|
||
- `CodePlay.Core.Common` - 公共类型和枚举
|
||
- `CodePlay.Core.Models` - 数据模型
|
||
- `CodePlay.Core.Interfaces` - 核心接口定义
|
||
- `CodePlay.Core.Parsers` - 语言解析器
|
||
- `CodePlay.Core.Converters` - 代码转换器
|
||
- `CodePlay.Core.Generators` - 代码生成器
|
||
- `CodePlay.Core.Services` - 服务层
|
||
- `CodePlay.Core.Validators` - 验证器
|
||
|
||
### 2. CodePlay.Web - Web API 服务
|
||
|
||
[查看 Web 模块文档](./modules/CodePlay.Web.md)
|
||
|
||
**主要功能**：
|
||
- REST API 端点
|
||
- Swagger 文档
|
||
- 依赖注入配置
|
||
|
||
**命名空间**：
|
||
- `CodePlay.Web.Controllers` - API 控制器
|
||
|
||
### 3. CodePlay.CLI - 命令行工具
|
||
|
||
[查看 CLI 模块文档](./modules/CodePlay.CLI.md)
|
||
|
||
**主要功能**：
|
||
- 命令行参数解析
|
||
- 批量文件转换
|
||
- 配置管理
|
||
|
||
**命名空间**：
|
||
- `CodePlay.CLI.Commands` - 命令定义
|
||
- `CodePlay.CLI.Services` - CLI 服务
|
||
|
||
### 4. CodePlay.Tests - 测试项目
|
||
|
||
[查看测试模块文档](./modules/CodePlay.Tests.md)
|
||
|
||
**主要功能**：
|
||
- 单元测试（xUnit）
|
||
- 集成测试
|
||
- 测试用例库
|
||
|
||
**命名空间**：
|
||
- `CodePlay.Tests.Parsers` - 解析器测试
|
||
- `CodePlay.Tests.Converters` - 转换器测试
|
||
|
||
## 快速开始
|
||
|
||
### 构建项目
|
||
|
||
```bash
|
||
dotnet build CodePlay.sln
|
||
```
|
||
|
||
### 运行测试
|
||
|
||
```bash
|
||
dotnet test CodePlay.Tests/CodePlay.Tests.csproj
|
||
```
|
||
|
||
### 启动 Web API
|
||
|
||
```bash
|
||
dotnet run --project CodePlay.Web/CodePlay.Web.csproj
|
||
```
|
||
|
||
## 支持的转换
|
||
|
||
| 源语言 | 目标语言 | 状态 |
|
||
|-------|---------|------|
|
||
| C# | Java | ✅ 已实现 |
|
||
| Java | C# | 🔄 计划中 |
|
||
| C# | C++ | 🔄 计划中 |
|
||
| C++ | C# | 🔄 计划中 |
|
||
| Java | C++ | 🔄 计划中 |
|
||
| C++ | Java | 🔄 计划中 |
|
||
|
||
## 项目状态
|
||
|
||
- **当前版本**: 0.1.0-alpha
|
||
- **开发阶段**: MVP 开发中
|
||
- **测试覆盖率**: 13 个测试用例，全部通过
|
||
|
||
## 相关链接
|
||
|
||
- [需求文档](../specs/codeplay-conversion-platform/requirements.md)
|
||
- [设计文档](../specs/codeplay-conversion-platform/design.md)
|
||
- [任务列表](../specs/codeplay-conversion-platform/tasklist.md)
|