${项目名} 源码解析

  作者:Trinea

本文为 Android 开源项目源码解析 中 ${项目名} 部分
项目地址:${项目名},分析的版本:${commitId}.substring(0, 7),Demo 地址:${项目名} Demo
分析者:${分析者},分析状态:未完成,校对者:Trinea,校对状态:未开始

建议大家看下 VolleyUILDaggerEvent Bus 的分析,了解分析该到什么程度,以及类似流程图和总体设计该怎么做。

 

复制一份到自己的项目文件夹下,然后根据自己项目替换掉 ${} 内容,删掉本行及上面两行。

 

1. 功能介绍

功能介绍,包括功能或优点等

 

完成时间

  • 一天内完成

 

2. 详细设计

2.1 类详细介绍

类及其主要函数功能介绍、核心功能流程图,流程图可使用 Google DrawingVisioStarUML

 

2.2 类关系图

类关系图,类的继承、组合关系图,可是用 StarUML 工具。

 

完成时间

  • 根据项目大小而定,目前简单根据项目 Java 文件数判断,完成时间大致为:文件数 * 7 / 10天,特殊项目具体对待

 

3. 流程图

主要功能流程图

  • 如 Retrofit、Volley 的请求处理流程,Android-Universal-Image-Loader 的图片处理流程图
  • 可使用 Google DrawingVisioStarUML 等工具完成,其他工具推荐??
  • 非所有项目必须,不需要的请先在群里反馈

 

完成时间

  • 两天内完成

 

4. 总体设计

整个库分为哪些模块及模块之间的调用关系。

  • 如大多数图片缓存会分为 Loader 和 Processer 等模块。
  • 可使用 Google DrawingVisioStarUML 等工具完成,其他工具推荐??
  • 非所有项目必须,不需要的请先在群里反馈。

 

完成时间

  • 两天内完成

 

5. 杂谈

该项目存在的问题、可优化点及类似功能项目对比等,非所有项目必须。

 

完成时间

  • 两天内完成

 

6. 修改完善

在完成了上面 5 个部分后,移动模块顺序,将
2. 详细设计 -> 2.1 核心类功能介绍 -> 2.2 类关系图 -> 3. 流程图 -> 4. 总体设计
顺序变为
2. 总体设计 -> 3. 流程图 -> 4. 详细设计 -> 4.1 类关系图 -> 4.2 核心类功能介绍
并自行校验优化一遍,确认无误后将文章开头的
分析状态:未完成
变为:
分析状态:已完成

 

本期校对会由专门的Buddy完成,可能会对分析文档进行一些修改,请大家理解。

 

完成时间

  • 两天内完成

 

到此便大功告成,恭喜大家^_^

 

大家有兴趣可以加入分析组,一起完善源码分析,给我发邮件 trinea.cn@gmail.com

随手点击下面广告,支持我维护本站吧
随手点击下面广告支持我免费维护吧
Android 开发经验分享
随手点击下面广告支持本站吧
 
Android 开发经验分享