Skip to content

Commit de86f01

Browse files
committed
Add template
1 parent 1864107 commit de86f01

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

common/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
项目名 实现原理解析
22
====================================
33

4-
##### 1. 功能介绍
4+
### 1. 功能介绍
55
提交功能介绍,包括功能、优点等
66

77

8-
##### 2. 详细设计
8+
### 2. 详细设计
99
包括核心类功能介绍,类关系图
1010
- 核心类介绍,包括类功能及核心函数功能
1111
- 类关系图,类的继承及调用关系图,工程太小此步骤可忽略
1212
- 可使用 StartUML 工具,其他工具推荐??
1313

14-
##### 3. 流程图
14+
### 3. 流程图
1515
功能流程图
1616
- 如 Retrofit、Volley 的请求处理流程,Android-Universal-Image-Loader 的图片处理流程图
1717
- 可使用 Visio 等工具完成,其他工具推荐??
1818
- 非所有项目必须,不需要的请先在群里反馈
1919

20-
##### 4. 总体设计
20+
### 4. 总体设计
2121
整个库分为哪些模块及模块之间的调用关系
2222
- 如大多数图片缓存会分为 Loader 和 Processer 等模块
2323
- 可使用 Visio 等工具完成,其他工具推荐??
2424
- 非所有项目必须,不需要的请先在群里反馈
2525

26-
##### 5. 杂谈
26+
### 5. 杂谈
2727
该项目存在的问题及可优化点等,非所有项目必须
2828

29-
##### 6. 修改完善
29+
### 6. 修改完善
3030
按照反顺序,从`总体设计` -> `流程图` -> `详细设计` -> `功能介绍` -> 示例工程自行校验优化一遍。
3131
确认无误后,将`4. 总体设计` -> `3. 流程图` -> `2. 详细设计` 顺序倒置,并删除本文当内容提示语句

0 commit comments

Comments
 (0)