代码规范及项目冲刺任务安排
格式描述
| 这个作业属于哪个课程 | 班级的链接 |
|---|---|
| 这个作业要求在哪里 | 团队作业第五次——站立式会议+alpha冲刺 |
| 团队名称 | 学长帮帮忙组 |
| 这个作业的目标 | 确定代码规范、发布10天项目任务 |
| 作业正文 | 代码规范及alpha冲刺任务计划 |
| 其他参考文献 | 百度 |
代码规范
缩进
采用四个空格。
变量命名
2.1 成员变量、局部变量都统一使用lowerCamelCase风格，遵从驼峰形式。
2.2 常量命名全部大写，单词间用下划线隔开。
每行最多字符数
-
单行字符数限制不超过 120个，超出需要换行，换行时遵循如下原则：
3.1 第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进。 3.2 运算符与下文一起换行。 3.3 方法调用的点符号与下文一起换行。 3.4 在多个参数超长，逗号后进行换行。 3.5 在括号前不要换行。
函数
-
函数最大行数尽量不超过一屏。
-
函数名统一使用lowerCamelCase风格，必须遵从驼峰形式。
-
类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / BO / DTO / VO等。
常量
-
不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。
-
long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
-
不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts下；系统配置相关的常量放在类：ConfigConsts下。
-
常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
-
跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。
-
应用内共享常量：放置在一方库的modules中的constant目录下。
-
子工程内部共享常量：即在当前子工程的constant目录下。
-
包内共享常量：即在当前包下单独的constant目录下。
-
类内共享常量：直接在类内部private static final定义。
-
如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性，必须使用Enum类，
-
空行、注释
-
方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
-
类、类属性、类方法的注释必须使用Javadoc规范，使用/**内容*/格式，不得使用//xxx方式。
-
所有的抽象方法（包括接口中的方法）必须要用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。 -
所有的类都必须添加创建者信息。
-
方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
-
所有的枚举类型字段必须要有注释，说明每个数据项的用途。
-
与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
-
代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。 -
注释掉的代码尽量要配合说明，而不是简单的注释掉。
说明：代码被注释掉有两种可能性：-
后续会恢复此段代码逻辑。
-
永久不用。
-
前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。
-
-
对于注释的要求：
-
能够准确反应设计思想和代码逻辑；
-
能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。
-
好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。
-
特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
-
待办事宜（TODO）:（标记人，标记时间，[预计处理时间]）表示需要实现，但目前还未实现的功能。这实际上是一个Javadoc的标签，目前的Javadoc还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个Javadoc标签）。
-
错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况。
-
-
其他规则
-
枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
-
代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
-
代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
-
任何运算符左右必须加一个空格
十天alpha冲刺任务
| 时间 | 后端 | 前端 |
|---|---|---|
| 4.26 | 熟悉Pycharm的基本使用，阅读代码规范 | 熟悉Android Studio的使用，阅读《第一行代码》 |
| 4.27 | 数据库的构建以及环境配置 | 完成登录 注册 找回密码等基础功能 |
| 4.28 | 完成注册、登录、找回密码等基础功能 | 完成认证 学业情况 笔记模块布局 |
| 4.29 | 完成认证、获取成绩接口、笔记模块等基本功能 | 完成修改头像 个人中心 |
| 4.30 | 完成获取头像、获取资料等用户基本操作接口 | 完成发布笔记 查看笔记 我的笔记 辅导模块布局 |
| 5.01 | 完成笔记模块的基本功能以及辅导模块的初始化构建 | 完成发布辅导 查看辅导 我的辅导 |
| 5.02 | 完成预约等基础功能 | 完成辅导预约 |
| 5.03 | 完成辅导模块所有功能 | 完成查看辅导记录 辅导评价 |
| 5.04 | 迭代更新完善接口代码 | 完成辅导列表 辅导搜索 |
| 5.05 | Alpha版本程序测试 | Alpha版本程序测试 |
