团队作业——系统设计
一、完善规格说明书
- 添加关于后端数据库的内容。
二、编码规范
命名规范
1、包名
- 包名全部小写，连续单词只是简单的连接起来，不使用下划线。
2、类名
-
类名均以UpperCamelCase风格编写，大驼峰命名法，如WelcomeActivity。尽量避免缩写，除非该缩写是众所周知的，比如HTML，URL，如果类名称中包含单词缩写，则每个单词都应该要大写。
-
测试类的命名以它要测试的类的名称开始，以Test结束，如HashTest.
接口：命名规则与类一样采用大驼峰命名法，多以able或ible结尾。
3、方法名
- 以lowerCamelCase风格编写，如initView();
4、常量名
- 常量名命名模式为CONSTANT_CASE，全部字母大写，用下划线分割单词。
5、非常量字段名
-
以lowerCamelCase风格的基础改造为如下风格：基本结构为scopeVariableNameType.
-
Scope 范围：非公有，非静态字段命名以m开头，静态字段命名以s开头；公有非静态字段命名以p开头，共有静态字段(全局变量)命名以g开头。如：int mPackagePrivate。
6、参数名
- 参数名以lowerCamelCase风格编写。参数名应该避免用单个字符命名。
7、局部变量名
- 局部变量名以lowerCamelCase风格编写，尽量避免使用单字符进行命名，除了临时变量和循环变量。
8、临时变量
- 临时变量通常被取名为i,j,k,m和n，它们一般用于整型；c,d,e一般用于字符型。
9、类型变量名
- 命名方式①、单个的大写字母，后面可以跟一个数字（如E,T,X,T2）；②、以类命名方式，后面加个大写的T（RequestT）。
资源文件规范
1、资源布局文件（XML文件（layout布局文件））
全部小写，采用下划线命名法
- 1)contentview命名
必须以全部单词小写，单词间以下划线分割，使用名词或使用名词词组。所有Activity或Fragment的contentView必须与其类名对应，对应规则为：将所有字母都转为小写，将类型和功能调换（也就是后缀变前缀）。如：activity_main.xml
- 2)Dialog命名
dialog_描述.xml,如：dialog_hint.xml
- 3)PopupWindow 命名
ppw_描述.xml ,如：ppw_info_xml
- 4)列表项命名
item_描述.xml,如：item_city.xml
- 5)包含项命名
模块_(位置)描述.xml，如：activity_main_head.xml
2、资源文件（图片drawable文件夹下）
全部小写，采用下划线命名法，加前缀区分，命名模式：可加后缀_small表示小图，_big表示大图，逻辑名称可由多个单词加下划线组成，采用以下规则：
-
用途_模块名_逻辑名称 -
用途_模块名_颜色 -
用途_逻辑名称 -
用途_颜色
注：用途也指控件类型
3、动画文件（anim文件夹下）
全部小写，采用下划线命名法，加前缀区分。具体动画采用以下规则：模块名_逻辑名称。
- 如：
fade_in----淡入
4、values中name命名
-
- strings.xml
strings的name命名使用下划线命名法，采用以下规则：模块名+逻辑名称
- 2)layout中的id命名
命名模式为：view缩写_模块名_逻辑名，比如btn_main_search
使用 AndroidStudio 的插件 ButterKnife Zelezny，生成注解非常方便，或者也可以使用Android Code Generator插件。
注释规范
1、类注释
每个类完成后应该有作者姓名和联系方式的注释，对自己的代码负责。
2、方法注释
每一个成员方法（包括自定义成员方法、覆盖方法、属性方法）的方法头都必须做方法头注释。
3、块注释
块注释与其周围的代码在同一缩进级别。它们可以是/* ... */风格，也可以是// ...风格(// 后最好带一个空格）。对于多行的/* ... */注释，后续行必须从*开始，并且与前一行的*对齐。
三、项目ER图
四、后端功能架构设计
- 我们组的后端架构设计以各界面功能为主体设计，在原型设计阶段时，我们现在考虑的主要界面，包括刚进入APP的首页，拍摄图片界面，从相册导入图片界面，编辑界面，预览界面以及生成各个随心摘后的浏览界面，不单单需要考虑界面中交互按钮功能的实现，另外，最重要的就是考虑前端和图片识别算法之间的对接，还有就是APP中用户信息在数据库存储之间的交互。
五、分而治之
1、WBS看板
2、团队工作分配
3、TODOLIST
-
后台数据库搭建：631
-
图像识别预处理：642、609
-
图像识别文字识别：642、609
-
图像识别语言纠错：642、609
-
前端界面及交互——首页：614、644、634
-
前端界面及交互——拍摄界面：643、641
-
前端界面及交互——随心摘浏览：643、641
-
前端界面及交互——相册照片导入：643、641
-
前端界面及交互——随心摘编辑：614、644、634
-
前端界面及交互——编辑完成预览：644、641
-
前端与识别算法对接：642、609
六、本次作业分工比例
| 学号 | 姓名 | 工作比例 |
|---|---|---|
| 031502634 | 杨光海天 | 12.5% |
| 031502609 | 郭剑南 | 10% |
| 031502614 | 赖志平 | 15% |
| 031502631 | 吴伟根 | 10% |
| 031502641 | 郑珍发 | 12.5% |
| 031502642 | 周琪文 | 12.5% |
| 031502643 | 朱晓健 | 15% |
| 031502644 | 邹星 | 12.5% |
