赛博厨神——代码规范、冲刺任务与计划

赛博厨神队 2025-10-31 01:17:45

这个作业属于哪个课程	2501_CS_SE_FZU
这个作业要求在哪里	团队作业——站立式会议+α冲刺
这个作业的目标	确定整体团队代码规范，并制定α冲刺相关计划
其他参考文献	《阿里巴巴Java开发手册》

一. 代码格式

1.1 命名规范

1.代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束，并且严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
2.类名使用 UpperCamelCase风格，方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从
驼峰形式。
3.常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
4.抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类
命名以它要测试的类的名称开始，以 Test 结尾。
5.包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用
单数形式，但是类名如果有复数含义，类名可以使用复数形式。
6.如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
7.接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁
性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是
与接口方法相关，并且是整个应用的基础常量。
8.枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

1.2 注释规约

1.所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、
异常说明外，还必须指出该方法做什么事情，实现什么功能。
2.所有的类都必须添加创建者和创建日期。
3.方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释
使用/* */注释，注意与代码对齐。
4.代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑
等的修改。
5.对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含
义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同
天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看
的，使其能够快速接替自己的工作。

1.3 异常处理

1.异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。
2.对大段代码进行 try-catch，这是不负责任的表现。catch 时请分清稳定代码和非稳
定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分
异常类型，再做对应的异常处理。
3.捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请
将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的
内容。
4.有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回
滚事务。
5.不能在 finally 块中使用 return，finally 块中的 return 返回后方法结束执行，不
会再执行 try 块中的 return 语句。

二.冲刺任务与计划

2.1 冲刺分工

学号	姓名	工作内容
102300102	肖窈	参与web端开发，担任ai测试员
102300101	许云湘	参与web端开发，担任ai设计师
222200334	季致涵	完成后端社交模块以及相关接口
222200402	王成桢	参与web端开发，担任ai程序员
102300204	黄子妍	参与移动端开发
102300105	郭晶晶	参与移动端开发
102300108	陈茜蕾	参与移动端开发
102300303	梁佳	完成后端菜谱模块以及相关接口
102300304	林琬茗	参与web端开发
102300302	侯晴宇	完成后端用户模块以及相关接口

2.2 总体计划

天数	计划目标	主要人员安排	产出物/验收标准
第一天	集中排查JWT令牌生成、验证及接口拦截配置；移动端和Web端使用后端提供的真实登录/注册接口；替换之前的Mock数据，确定Git分支管理策略，所有人学习并实践代码提交与合并	全体成员	1. 前端能成功调用后端登录接口并收到有效Token。2. 团队成员能熟练地将代码提交至各自仓库。
第二天	完成“发布菜谱”界面逻辑与后端接口对接；优化“我的”模块下各页面（我的发布、收藏等）的静态页面；完成Web端首页、菜谱分类/详情页的静态页面搭建；后端为已完成的移动端页面（如社区、菜谱列表）提供数据接口	全体成员	1. 移动端“发布菜谱”页面表单项完整，逻辑清晰。2. Web端至少有2个核心页面可展示。3. 移动端首页能显示来自后端的真实菜谱列表数据。
第三天	后端完成菜谱发布（含图片/视频上传）接口；移动端“发布菜谱”功能正式对接后端，实现菜谱数据（含封面图）提交并存入数据库；Web端和移动端的菜谱详情页能根据ID请求并展示后端返回的完整菜谱信息	全体成员	1. 能在移动端成功发布一篇菜谱，并在后端数据库查看到数据。2. 在移动端或Web端能浏览到新发布的菜谱详情。
第四天	后端完成社区模块的核心接口（如首页信息流、点赞、收藏）；移动端社区页面能显示发布的菜谱动态，并实现点赞/收藏的交互效果；“我的发布”、“我的收藏”页面能显示对应用户的真实数据	后端组、移动端组	1. 在移动端社区页面能看到其他用户发布的菜谱。2. 点击点赞/收藏按钮，后端能正确记录状态，且“我的收藏”页面能同步更新。
第五天	按照“注册 -> 登录 -> 浏览 -> 发布 -> 互动”的完整流程进行交叉测试；集中修复测试中发现的界面、交互和逻辑错误；统一界面风格，修复明显的布局错乱和操作卡顿问题	全体成员	1. 核心用户流程畅通无阻，无阻塞性Bug。2. 应用界面在不同设备上基本正常显示。
第六天	准备演示脚本，固化演示环境，冲刺评审会	全体成员	1. 一个流畅的5分钟演示，完整展示软件的核心价值。2. 一份团队总结，为下一次冲刺积累经验。