欢迎阅读项目A的开发规范文档!请务必仔细阅读以下内容以确保代码质量和团队协作效率。
📌 代码规范
命名规范
- 类名使用
PascalCase
- 方法名使用
snake_case
- 变量名需体现用途(示例:
user_id
而非uid
)
✅ 保持代码可读性是团队协作的核心
- 类名使用
文件结构
/project-a ├── /src # 主代码源文件 ├── /docs # 文档目录 ├── /tests # 单元测试 └── /deploy # 部署配置
📁 所有新模块请遵循此目录结构
版本控制
- 使用 Git 管理代码
- 提交信息需遵循 Conventional Commits
- 每个功能分支需以
feature/
开头(如feature/user_auth
)
🧩 开发流程
- 需求分析 → 2. 技术方案设计 → 3. 代码实现 → 4. 单元测试 → 5. 代码审查 → 6. 部署上线
🔄 每个阶段需同步更新 项目进度看板
📚 扩展阅读
请在开发前务必熟悉 项目A代码风格指南 中的详细规范!