📘 本指南旨在为团队提供统一的开发规范，提升代码质量和项目协作效率。点击这里查看代码质量相关政策。

1. 概述

  • 适用范围：所有项目开发流程
  • 核心目标：确保代码可维护性、可读性与一致性
  • 📌 重要性：遵循标准可减少 30% 以上的返工成本（数据来源：项目效率报告）
Development_Process

2. 编码规范

2.1 代码风格

  • 使用 Google Java Style Guide 作为默认参考
  • 变量命名：驼峰式（如 userName） vs 帕斯卡式（如 UserManager）
  • 代码格式：4 空格缩进，每行不超过 80 字符

2.2 文档要求

  • 必须包含：功能说明、接口定义、异常处理
  • 推荐使用：Markdown + 代码块注释
  • ❗ 未达标项目将无法通过代码审查
Code_Standards

3. 项目结构

  • 标准目录布局：
    • src/：核心源代码
    • docs/：技术文档
    • test/：单元测试
    • resources/：配置文件
  • 📁 必须包含 README.md 文件，说明项目依赖与构建方式
  • 推荐使用：项目结构模板

4. 协作流程

  • 代码提交：
    • 遵循 Conventional Commits 规范
    • 提交信息格式：<类型>: <描述>（如 feat: 添加登录功能）
  • 代码审查：
    • 必须通过 2 名开发者审核
    • 使用 📝 评论功能指出潜在问题
  • 部署规范：
    • 遵循 CI/CD 流程
    • 禁止直接推送至生产环境分支
Team_Collaboration

5. 扩展阅读