CoReview - 团队协作代码审查工具
📖 产品介绍
CoReview 是一款专为开发团队设计的代码审查工具，让您可以直接在 VS Code 中完成所有的代码审查工作。通过现代化的界面和智能的功能设计，帮助团队提升代码质量，加强协作效率。
✨ 核心功能
🔐 用户认证
- 服务端配置：支持配置您的企业代码审查服务端
- 用户登录：使用您的企业账号密码登录系统
- 状态管理：自动记住登录状态，无需重复登录
📋 项目管理
- 多项目支持：可以同时管理多个项目的代码审查
- 项目切换：在界面上快速切换不同项目
- 项目筛选：按项目过滤审查记录
🔍 审查记录管理
- 三种视图模式：
- 全部：查看所有审查记录
- 我提交的：只显示您提交的审查
- 待我确认：只显示需要您确认的审查
- 智能筛选：快速找到您关心的审查记录
✏️ 在线编辑
- 直接编辑：在表格中直接编辑审查意见
- 多种输入方式：支持文本、多行文本、日期、下拉选择等
- 实时保存：编辑内容自动保存，避免数据丢失
- 批量操作：支持批量编辑和提交
📊 数据同步
- 本地缓存：编辑数据保存在本地，支持离线编辑
- 服务器同步：一键提交所有修改到服务器
- 状态跟踪：实时显示编辑状态和同步进度
🚀 快速开始
1. 安装扩展
在 VS Code 中搜索并安装 "CoReview" 扩展
2. 配置服务端
- 打开 VS Code 侧边栏的 CoReview 面板
- 在登录页面配置您的企业代码审查服务端地址
- 点击"测试连接"确保连接正常
3. 用户登录
4. 开始使用
- 选择要管理的项目
- 选择查看模式（全部/我提交的/待我确认）
- 开始查看和编辑代码审查记录
💡 使用指南
查看审查记录
- 在项目下拉框中选择要查看的项目
- 在状态筛选中选择查看模式
- 表格中会显示对应的审查记录
- 点击表头可以按列排序
编辑审查意见
- 点击表格中的任意单元格进入编辑模式
- 根据字段类型进行相应的编辑操作
- 按 Enter 键提交修改，按 Escape 键取消
- 编辑的内容会自动保存到本地
提交修改
- 完成编辑后，点击顶部的"提交"按钮
- 系统会显示确认对话框
- 确认后，所有修改会提交到服务器
- 提交成功后，数据版本会自动更新
重置编辑
- 如果需要撤销所有编辑，点击"重置"按钮
- 系统会显示确认对话框
- 确认后，所有编辑内容会恢复到原始状态
🎯 适用场景
开发团队
- 代码质量保证：通过系统化的代码审查流程提高代码质量
- 知识分享：团队成员间的代码评审交流
- 标准化流程：统一的代码审查工作流程
项目管理
- 多项目管理：统一管理多个项目的审查工作
- 进度跟踪：通过筛选功能跟踪审查进度
- 责任明确：清晰区分提交者和确认者
个人开发
- 个人记录：查看自己提交的所有审查
- 待办事项：快速找到需要处理的审查
- 历史回顾：回顾过去的审查记录
🔧 常用操作
界面操作
- 项目选择：点击项目下拉框选择项目
- 状态筛选：点击状态按钮切换查看模式
- 表格排序：点击表头进行排序
- 编辑模式：点击单元格进入编辑模式
数据操作
- 批量编辑：可以同时编辑多条记录
- 批量提交：一次性提交所有修改
- 批量重置：一键重置所有编辑内容
📈 产品价值
提升开发效率
- 无缝集成：直接在开发环境中处理审查，无需切换工具
- 批量操作：支持批量处理，大幅提高工作效率
- 智能保存：自动保存编辑内容，避免数据丢失
加强团队协作
- 角色分工：明确的评审人和确认人角色分工
- 流程标准化：统一的代码审查流程和标准
- 状态透明：清晰的审查状态跟踪和进度展示
保证代码质量
- 系统化审查：标准化的代码审查流程
- 版本控制：与代码版本控制系统深度集成
- 历史追溯：完整的审查历史记录和变更追踪
🆘 常见问题
连接问题
Q: 无法连接到服务端怎么办？
A: 请检查服务端地址是否正确，确保网络连接正常，然后重新测试连接。
登录问题
Q: 登录失败怎么办？
A: 请确认用户名和密码是否正确，如果问题持续，请联系系统管理员。
数据同步问题
Q: 编辑的数据没有保存怎么办？
A: 编辑内容会自动保存到本地，请点击"提交"按钮将数据同步到服务器。
权限问题
Q: 某些功能无法使用怎么办？
A: 请确认您的账号权限，不同角色可能拥有不同的功能权限。
📞 技术支持
如果您在使用过程中遇到问题，可以通过以下方式获取帮助：
- 查看帮助文档：在 VS Code 中按 F1 打开命令面板，搜索 "CoReview"
- 联系管理员：联系您的系统管理员获取技术支持
- 反馈问题：通过 VS Code 的反馈功能报告问题
📝 更新日志
v0.0.1
- 初始版本发布
- 支持基本的代码审查功能
- 支持多项目管理
- 支持在线编辑和批量操作
CoReview - 让代码审查更简单、更高效！
| |
