code-review.md

此Code Review标准旨在确保代码质量、可维护性、安全性和团队协作效率。

---

Code Review 标准

1. 代码可读性

• 命名约定
  • 变量、函数和类的名称应清晰、描述性强，避免缩写或无意义的名称（如 x、tmp）
  • 变量、函数和类的名称采用驼峰命名
• 代码格式
  • 代码缩进一致
  • 每行不超过 80-120 个字符，过长代码合理换行。
• 注释
  • 为复杂逻辑、关键函数或类添加简洁的注释，说明意图和用途。
  • 避免冗余注释（如 // 设置变量 a）。
• 函数/方法长度
  • 每个函数应尽量短小，专注于单一职责，建议不超过 20-30 行。
  • 所有函数必须声明参数类型和返回值类型
  • 所有函数必须包含注释

2. 功能正确性

• 需求实现
  • 代码是否完整实现需求，且无明显的功能遗漏。
• 边界条件
  • 检查代码是否处理了边缘情况（如空输入、超大值、非法参数）。
• 错误处理
  • 所有可能的异常或错误都被捕获并妥善处理，避免程序崩溃。
  • 错误信息对用户友好，同时记录详细日志供调试。

3. 代码质量

• 单一职责原则 (SRP)
  • 每个类、函数或模块只负责一项功能，避免“万能类”或“超级函数”。
• 代码重复
  • 消除重复代码，提取为可复用的函数、类或模块（遵循 DRY 原则：Don't Repeat Yourself）。
• 未使用代码
  • 删除未使用的变量、函数或导入语句。
• 模块化
  • 代码按逻辑分层（如 MVC 模式），模块间耦合度低。