饭醉团队——代码规范、冲刺任务与计划

[饭醉团队]

这个作业属于哪个课程	2301-计算机学院-软件工程
这个作业要求在哪里	团队作业——站立式会议+alpha冲刺
这个作业的目标	制定代码规范、冲刺任务与计划
团队名称	饭醉团队
团队项目	知食分子
团队随笔置顶集合	饭醉团队——Alpha冲刺随笔置顶
其他参考文献	Google-java-coding-style

目录

• 一、代码规范
• 1.命名规范
• 2.代码结构
• 3.注释
• 4.异常处理
• 5.代码质量
• 6.安全性
• 二、alpha冲刺任务与计划
• 1.任务
• 1.1 微信登录
• 1.2 所有店铺信息、菜品信息
• 1.3 固定分类
• 1.4 搜索
• 1.5 随机一道菜
• 1.6 首页下方的推荐菜品
• 1.7 菜品评论、给菜品评分（0~5星，没人评分默认0）
• 2.计划
• 2.1 冲刺时间
• 2.2 阶段任务
• 2.3 人员分工

一、代码规范

1.命名规范

• 包名：包名应该采用全小写字母，采用倒置的域名形式，例如：host.luke.FoodIntellectuals
• 类名：采用驼峰命名法（CamelCase），首字母大写，例如：MyClass
• 方法名：同样使用驼峰命名法，例如：calculateTotalPrice()
• 变量名：采用驼峰命名法，例如：orderCount
• 常量：使用全大写字母，用下划线分隔单词，例如：MAX_CAPACITY
• 缩写词：避免使用单一字母的缩写，尽量使用完整的词汇来命名变量和方法

2.代码结构

• 缩进：使用两个空格进行缩进
• 大括号：大括号应该位于同一行的代码块后，例如：

  if (condition) {
    someCode(here);
  }
  

• 方法长度：尽量保持方法的长度不超过 40 行
• 空行：在方法之间和逻辑块之间使用空行，以提高可读性

3.注释

• 注释：在代码中使用有意义的注释，以解释重要的业务逻辑和算法，但不要滥用注释
• Javadoc：对公共API、接口和类使用Javadoc注释，以描述其用途、参数和返回值

4.异常处理

• 异常处理：在合适的地方捕获和处理异常，避免捕获所有异常（不要使用空的catch块）
• 异常类型：捕获特定的异常类型，而不是通用的Exception

5.代码质量

• 可读性：编写易于阅读和理解的代码，避免过于复杂的逻辑
• 单一职责原则：每个类和方法应该只负责一个明确定义的任务
• 代码重用：尽量重用现有的代码，避免重复编写相似的功能
• 单元测试：编写单元测试来验证代码的正确性，确保代码的稳定性

6.安全性

• 配置文件: 严禁将配置文件上传到github上，有需要配置文件以启动项目的可以向负责人申请配置文件包

二、alpha冲刺任务与计划

1.任务

完成基础功能部分的开发。

1.1 微信登录

• 默认头像和用户名使用微信的头像和用户名

1.2 所有店铺信息、菜品信息

• 店铺信息：地址（如紫荆园一楼）、店铺头像图片、店铺名称、店铺评分/人均价格（由各项菜品评价得到）
• 菜品信息：菜品名、菜品图片、菜品价格、品类标签、口味标签、菜品评分

1.3 固定分类

• 按菜品品类/口味分类
• 按食堂地点分类

1.4 搜索

• 可以搜索分类或店铺或菜品
• 直接搜索店铺名称、菜品名称
• 按照菜品品类标签、口味标签分类搜索

1.5 随机一道菜

• 可把范围限定在某个收藏夹
• 或使用菜品、口味分类标签
• 或完全随机，在所有菜中随机

1.6 首页下方的推荐菜品

• 只显示菜的图片，点击图片跳转到展示菜名、评论的界面

1.7 菜品评论、给菜品评分（0~5星，没人评分默认0）

2.计划

2.1 冲刺时间

alpha冲刺时间为：11.07-11.16

2.2 阶段任务

时间安排	具体任务
11.07-11.08	整理上传数据、登录功能、主页功能、首页推荐
11.09-11.10	店铺/菜品界面
11.11-11.12	店铺/菜品界面、收藏夹
11.13-11.14	搜索筛选
11.15-11.16	随机推荐、评论评分

2.3 人员分工

具体分工	人员
产品经理	刘敏、贺心悦
UI	陈朝辉
前端	范远生、庄泽、刘敏、贺心悦
后端	魏知乐、陈建辉、詹中智、黄咏清、苏怡月