We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent b1e2de7 commit 1864107Copy full SHA for 1864107
common/README.md
@@ -0,0 +1,31 @@
1
+项目名 实现原理解析
2
+====================================
3
+
4
+##### 1. 功能介绍
5
+提交功能介绍,包括功能、优点等
6
7
8
+##### 2. 详细设计
9
+包括核心类功能介绍,类关系图
10
+- 核心类介绍,包括类功能及核心函数功能
11
+- 类关系图,类的继承及调用关系图,工程太小此步骤可忽略
12
+- 可使用 StartUML 工具,其他工具推荐??
13
14
+##### 3. 流程图
15
+功能流程图
16
+- 如 Retrofit、Volley 的请求处理流程,Android-Universal-Image-Loader 的图片处理流程图
17
+- 可使用 Visio 等工具完成,其他工具推荐??
18
+- 非所有项目必须,不需要的请先在群里反馈
19
20
+##### 4. 总体设计
21
+整个库分为哪些模块及模块之间的调用关系
22
+- 如大多数图片缓存会分为 Loader 和 Processer 等模块
23
24
25
26
+##### 5. 杂谈
27
+该项目存在的问题及可优化点等,非所有项目必须
28
29
+##### 6. 修改完善
30
+按照反顺序,从`总体设计` -> `流程图` -> `详细设计` -> `功能介绍` -> 示例工程自行校验优化一遍。
31
+确认无误后,将`4. 总体设计` -> `3. 流程图` -> `2. 详细设计` 顺序倒置,并删除本文当内容提示语句
0 commit comments