| 这个作业属于哪个课程 | 至诚软工实践F班 |
|---|---|
| 这个作业要求在哪里 | 第五次团队作业：项目冲刺 |
| 这个作业的目标 | 规定代码规范，明确冲刺阶段计划与目标 |
一、代码规范
（一）命名风格
-
所有编程相关的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
-
所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
-
方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格（驼峰命名法）。
-
常量命名应该全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
-
避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理解性降低。
-
杜绝完全不规范的英文缩写，避免望文不知义。
（二）代码格式
-
若函数或过程中的参数较长，则要进行是适当的划分。
-
注释的双斜线与注释内容之间有且仅有一个空格。
-
方法参数在定义和传入时，多个参数逗号后面必须加空格。
-
程序块要采用缩进风格编写，缩进的空格数为4个，避免使用Tab进行缩进。
-
较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
-
循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
-
不允许把多个短语句写在一行中，即一行只写一条语句。
-
if、for、do、while、case、switch、default等语句自占一行，且.if、for、do、while等语句的执行语句部分无论多少都要加括号{}.
（三）注释规约
-
类、类属性、类方法的注释必须使用 Javadoc 规范，使用 /** 内容 */ 格式，不得使用 // xxx方式。
-
所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数异常说明外，还必须指出该方法做什么事情，实现什么功能。
-
方法内部单行注释，在被注释语句上方另起一行，使用 // 注释。方法内部多行注释使用 /* */注释，注意与代码对齐。
-
代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等。
-
好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的另一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释又是相当大的负担。
-
选择熟悉的、可以正确表达代码含义的语言进行注释，不必追求英文注释。
（四）可读性
-
注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。
-
避免使用不易理解的数字，用有意义的标识来替代。
-
源程序中关系较为紧密的代码应尽可能相邻。
二、预期计划
| 计划天数 | 任务进度 |
|---|---|
| 第1天 | 进行小组会议，分配任务，明确个人分工 |
| 第2-3天 | 前端完成基础页面设计 后端完成各模块代码 |
| 第4-5天 | 前端完成页面跳转及组件功能实现 后端补足各模块缺失接口代码 |
| 第6-8天 | 前端进行UI统一及美化界面 后端测试并完善基础功能接口 |
| 第9-10天 | 前端调用后端接口，完成效果调用 后端辅助前端完成调用，进行相应的修改 |
| 第11天 | 前端测试、后端根据测试，修改并完善功能 |
| 第12天 | 收尾工作，验收最后成功、Bug修改和后期维护 |
三、预期目标
| 序号 | 功能点 | 功能实现 | 备注 |
|---|---|---|---|
| 1 | 登录 | 用户登录 | 密码登录或微信登录 |
| 2 | 发布 | 发布订单 | 正常发布 |
| 3 | 接受 | 接受订单 | 正常接受 |
| 4 | 搜索 | 搜索特定订单 | 无 |
| 5 | 取消 | 取消订单 | 正常取消 |
| 6 | 注册 | 注册账号 | 正常注册 |
| 7 | 退出 | 退出登录 | 正常退出 |
| 8 | 设置 | 绑定邮箱、重置密码 | 成功绑定邮箱、正常重置密码 |
