# Copilot不仅生成代码，还能：
# 1. 解释选中的代码块
# 2. 生成项目文档
# 3. 识别代码模式

# 企业级代码AI助手
# 功能特点：
# - 整个代码库语义搜索
# - 跨仓库代码理解
# - 自动生成文档

# 给AI的提示词：

我刚刚加入一个新项目，需要快速理解这个代码库。
请帮我分析以下项目结构：

[粘贴项目目录结构]

请回答：
1. 这是什么类型的项目？（Web应用/移动端/库/工具）
2. 主要技术栈是什么？
3. 项目架构看起来是怎样的？（MVC/微服务/等）
4. 入口点在哪里？
5. 有哪些关键的配置文件？

# 项目结构示例
my-project/
├── src/
│   ├── components/    # React组件
│   ├── pages/         # 页面组件
│   ├── services/      # API服务层
│   ├── utils/         # 工具函数
│   └── index.js       # 入口文件
├── package.json
├── docker-compose.yml
└── README.md

// 让AI分析package.json
/*
请分析这个package.json文件：
1. 主要依赖有哪些？
2. 构建工具是什么？
3. 有哪些开发脚本？
4. 项目使用了哪些代码质量工具？
*/

// webpack.config.js 或类似构建配置
/*
请解释这个Webpack配置：
1. 入口点是什么？
2. 如何处理不同类型的文件？
3. 开发和生产配置有什么区别？
4. 使用了哪些优化策略？
*/

# 示例：选中复杂函数，右键选择"Copilot" -> "解释代码"

def process_order(order_data, inventory, payment_gateway):
    """
    复杂的订单处理逻辑
    """
    # 让AI逐步解释这个函数
    # 1. 函数的目的
    # 2. 每个步骤的作用
    # 3. 可能的异常情况
    # 4. 性能考虑

# 有效的提问模式：

## 模式1：逐步深入
"这个函数做了什么？"
"这个函数被哪些其他函数调用？"
"如果参数X为null会怎样？"

## 模式2：关系挖掘
"请画出这个Service类的调用关系图"
"这个模块依赖哪些外部服务？"

## 模式3：修改影响
"如果我修改这个配置，会影响哪些功能？"
"这个函数的重构建议是什么？"

# 提示AI生成架构图：

请根据以下代码库信息，生成Mermaid架构图：

1. 前端：React + Redux
2. 后端：Express.js + MongoDB
3. 服务：用户服务、订单服务、支付服务
4. 消息队列：RabbitMQ
5. 缓存：Redis

请生成：
- 组件关系图
- 数据流图
- 部署架构图

graph TB
    Client[客户端] --> Nginx
    Nginx --> Frontend[前端React应用]
    Frontend --> API_Gateway[API网关]
    
    API_Gateway --> Auth_Service[认证服务]
    API_Gateway --> User_Service[用户服务]
    API_Gateway --> Order_Service[订单服务]
    
    Order_Service --> Payment_Service[支付服务]
    Order_Service --> Inventory_Service[库存服务]
    
    subgraph "数据层"
        MongoDB[(MongoDB)]
        Redis[(Redis缓存)]
        RabbitMQ[(消息队列)]
    end
    
    Auth_Service --> MongoDB
    User_Service --> MongoDB
    Order_Service --> MongoDB
    Order_Service --> Redis
    Payment_Service --> RabbitMQ

# 提示词模板：
"""
请审查以下代码，关注：
1. 潜在的安全漏洞
2. 性能问题
3. 代码风格不一致
4. 错误处理缺失
5. 测试覆盖率不足

代码：
[粘贴代码片段]
"""

// 询问AI识别设计模式
/*
这个代码库中使用了哪些设计模式？
请指出具体的文件和行号。

观察到的模式：
1. 工厂模式：在 factory.py 第 15-30 行
2. 观察者模式：在 event_handler.py 第 45-60 行
3. 策略模式：在 payment_strategies.py 第 22-40 行
*/

// 请求AI追踪特定数据
/*
请追踪用户注册的数据流：
1. 用户提交表单开始
2. 经过哪些验证步骤
3. 数据如何存储到数据库
4. 后续触发了哪些事件或通知
5. 返回给用户的响应如何生成
*/

# 代码库理解检查清单

第一阶段：快速扫描 (1-2小时)
  - [ ] 使用ChatGPT分析项目结构
  - [ ] 理解技术栈和依赖
  - [ ] 识别入口点和主要模块

第二阶段：深度探索 (3-4小时)
  - [ ] 使用Cursor探索核心业务逻辑
  - [ ] 用Copilot解释复杂函数
  - [ ] 追踪关键数据流
  - [ ] 识别设计模式和架构

第三阶段：文档化 (1-2小时)
  - [ ] 生成架构图
  - [ ] 创建API文档草稿
  - [ ] 编写核心流程说明
  - [ ] 标注待改进区域

# 给AI的提示词
"""
这是一个电商平台的后端代码库，我需要：
1. 理解订单处理完整流程
2. 找出支付集成的安全措施
3. 了解库存管理逻辑

请帮我：
1. 分析order_service.py的主要功能
2. 追踪从创建订单到完成支付的完整流程
3. 识别库存扣减和回滚机制
4. 找出所有与支付相关的API端点
"""

# 订单处理流程分析结果

## 1. 核心文件
- `order_service.py`: 订单业务逻辑 (L15-250)
- `payment_gateway.py`: 支付集成 (L45-120)
- `inventory_manager.py`: 库存管理 (L30-90)

## 2. 完整流程
1. 用户下单 → `OrderService.create_order()`
2. 库存检查 → `InventoryManager.reserve_stock()`
3. 支付处理 → `PaymentGateway.charge()`
4. 订单确认 → `OrderService.confirm_order()`
5. 库存扣减 → `InventoryManager.update_stock()`

## 3. 安全措施
- 支付token加密存储
- 库存操作的数据库事务
- 订单状态机防止重复处理

## 4. 待改进点
- 缺少分布式锁，可能导致超卖
- 支付回调没有重试机制
- 订单日志不够详细

# ❌ 不好的提问方式：
"解释这个项目"  # 太模糊
"这行代码什么意思"  # 缺少上下文
"修复所有bug"  # 不现实的要求

# ✅ 好的提问方式：
"基于main.js和utils.js，解释用户认证流程"
"第45行的正则表达式具体匹配什么模式？"
"请找出这个函数中可能的内存泄漏点"

// 1. 创建会话文档
/*
# 代码库理解会话 - 项目: E-commerce Platform
## 已了解：
- 使用React + Node.js + MongoDB
- 微服务架构，5个核心服务
- 使用JWT进行认证

## 待探索：
- 支付服务集成细节
- 缓存策略实现
- 错误处理统一机制

## 重要发现：
- 订单服务有竞态条件风险
- 用户服务缺少批量操作API
*/

# understand_codebase.py
"""
自动化代码库理解工具
结合多个AI API进行深度分析
"""

import os
from pathlib import Path

class CodebaseAnalyzer:
    def __init__(self, project_path):
        self.project_path = Path(project_path)
        
    def generate_analysis_prompt(self):
        """生成给AI的完整分析提示"""
        structure = self.get_project_structure()
        key_files = self.identify_key_files()
        
        prompt = f"""
        请分析以下代码库：
        
        项目结构：
        {structure}
        
        关键文件：
        {key_files}
        
        请提供：
        1. 项目类型和主要功能
        2. 技术架构分析
        3. 核心业务逻辑流程
        4. 潜在问题和改进建议
        """
        return prompt
    
    def get_project_structure(self, max_depth=3):
        """获取项目目录结构"""
        structure = []
        for root, dirs, files in os.walk(self.project_path):
            depth = root[len(str(self.project_path)):].count(os.sep)
            if depth > max_depth:
                continue
            indent = "  " * depth
            structure.append(f"{indent}{os.path.basename(root)}/")
            sub_indent = "  " * (depth + 1)
            for file in files[:10]:  # 限制文件数量
                if file.endswith(('.py', '.js', '.java', '.go', '.ts')):
                    structure.append(f"{sub_indent}{file}")
        return "\n".join(structure)

# 推荐工具组合
# 1. 使用tree命令获取结构
tree -I 'node_modules|dist|build' -L 3 --dirsfirst

# 2. 结合ripgrep搜索关键模式
rg -n "class.*Service|def.*api" --type py

# 3. 使用AI进行分析
curl -X POST https://api.openai.com/v1/chat/completions \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4",
    "messages": [{
      "role": "user",
      "content": "'"$(cat analysis_prompt.txt)"'"
    }]
  }'

# 代码库理解程度评估

## 架构理解 (0-10分)
- [ ] 能画出系统架构图 (2分)
- [ ] 理解数据流方向 (2分)
- [ ] 知道各组件职责 (2分)
- [ ] 了解部署结构 (2分)
- [ ] 掌握扩展方式 (2分)

## 代码理解 (0-10分)
- [ ] 能找到并解释任意函数 (2分)
- [ ] 理解核心业务逻辑 (2分)
- [ ] 知道如何添加新功能 (2分)
- [ ] 能修复简单bug (2分)
- [ ] 能进行代码审查 (2分)

## 领域理解 (0-10分)
- [ ] 理解业务领域模型 (3分)
- [ ] 知道关键业务流程 (3分)
- [ ] 了解用户需求映射 (2分)
- [ ] 掌握业务规则 (2分)

## 总分：__/30
# 25+：专家级理解
# 15-24：良好理解
# 10-14：基础理解
# <10：需要继续学习

# 测试你的理解程度
"""
基于你对代码库的理解，请：
1. 实现一个新功能：添加用户积分系统
2. 修复这个bug：[描述具体bug]
3. 优化这个慢查询：[提供查询示例]
4. 编写这个组件的测试用例
"""

# 如果能够完成以上任务，说明理解充分

# 项目知识库模板

## 项目卡片
- **项目名称**：
- **业务领域**：
- **核心价值**：
- **关键指标**：

## 架构图
[在这里粘贴Mermaid图]

## 核心流程
### 用户注册流程
1. 
2. 
3. 

### 订单处理流程
1. 
2. 
3. 

## 代码导航
### 重要文件
- `src/core/`: 核心业务逻辑
- `src/api/`: API端点定义
- `src/models/`: 数据模型

### 常用命令
```bash
# 启动开发环境
npm run dev

# 运行测试
npm test

# 构建生产版本
npm run build

### 10.2 定期更新理解
```python
# 每周理解更新脚本
def weekly_understanding_update():
    """
    每周花30分钟更新对代码库的理解
    """
    tasks = [
        "查看最近一周的提交记录",
        "了解新添加的功能模块",
        "检查架构是否有重大变更",
        "更新知识库文档",
        "与团队成员讨论理解差异"
    ]
    
    # 使用AI辅助更新
    prompt = """
    基于以下变更，更新我对代码库的理解：
    
    最近提交：
    [git log --since="1 week ago"]
    
    新文件：
    [find . -name "*.py" -mtime -7]
    
    请总结：
    1. 本周主要开发方向
    2. 架构或设计模式变化
    3. 需要我关注的重要变更
    """
    return prompt