1. 项目结构设计 ✅

  • 使用清晰的目录层级，如：/src 存放核心代码，/docs 保存文档说明
  • 遵循 MVC 模式分离逻辑、视图与控制器
  • 为第三方库单独创建 vendor 文件夹
project_structure

2. 代码规范 📄

  • 统一命名规则：变量用 snake_case，常量用 UPPER_SNAKE_CASE
  • 保持函数单一职责，避免超过 50 行
  • 使用类型注解提升可维护性
  • 参考：课程项目编码规范指南

3. 版本控制 📦

  • 初始化 Git 仓库后立即提交初始框架
  • 使用分支策略：main 用于稳定版本，dev 用于开发
  • 定期推送代码并保持本地仓库同步
version_control

4. 单元测试 ⚙️

  • 采用 TDD（测试驱动开发）模式
  • 覆盖核心功能模块，目标是 100% 代码覆盖率
  • 使用 mocking 工具隔离外部依赖
  • 测试框架推荐：课程项目测试工具专区

5. 文档编写 📖

  • 使用 Markdown 编写 README 文件
  • 为每个功能模块添加注释说明
  • 维护更新日志（CHANGELOG.md）
documentation