1. 模块化设计

保持代码结构清晰，按功能划分模块。每个模块应职责单一，避免功能混杂。

模块化设计
**推荐链接**: [/codebase/development_guidelines](/codebase/development_guidelines)（开发指南扩展阅读）

2. 版本控制_最佳实践

使用 Git 管理代码，遵循分支策略（如 Git Flow）。

  • 每次提交前确保代码通过测试
  • 使用有意义的提交信息 ✅
  • 定期合并主分支，避免功能积压
版本控制_最佳实践

3. 代码风格_统一

  • 遵循团队约定的编码规范（如 Prettier/ESLint）
  • 保持函数简短，控制在 5 行以内 ⚡
  • 使用空格而非 Tab 缩进 📝
代码风格_统一

4. 测试_自动化

  • 单元测试覆盖率应 ≥ 80% 🧪
  • 集成测试验证模块间交互 🔗
  • 每日构建中包含测试环节 🏋️‍♂️
测试_自动化

5. 文档_及时更新

  • API 文档需与代码同步 📖
  • 代码注释应解释「为什么」而非「是什么」 💡
  • 使用 Markdown 编写文档，保持格式简洁 🌐
文档_及时更新

6. 安全_基础

  • 输入验证防止注入攻击 ⚠️
  • 敏感信息通过环境变量管理 🔒
  • 定期进行代码审计 🕵️‍♂️
安全_基础

延伸学习: /codebase/code_quality（代码质量专题）