iOS 说明文档

为了方便项目维护及交接，特制定以下说明文档

1. 命名规则

详细命名更新在这里：
https://www.jianshu.com/p/c912521d4195

2. 整体结构

为方便开发和维护, 各功能模块, 文件夹分类确保清晰明了. 具体文件结构如下图所示

image.png

2. 详细模块结构

文件结构一般按模块或页面分类, 每个页做一个文件夹, 每个文件夹下, 再分 Controller, View, Model 或 ViewModel 文件夹, 用于放置,需要的文件.

image.png

3.项目框架

本项目框架是基于 UITabBarViewController + UINavigationViewController 设计, 第三工具类使用 cocoapods 管理, 设计模式以 MVC 为主, 部分模块使用 MVVM, MVP(面向协议) 模式编程.
每个功能模块都包含 Model, View, Controller, Tool, Service, 用于数据处理, 渲染, 用户交互等, 整体架构如下

image.png

4. 抽项目规范

抽项目，版本问题，遵循修改量少，bug少的原则去选择性抽取合适的版本；
抽项目，logo、启动图、引导页、和主色调保持一致的图片以及加载图
抽项目，项目里面的关键字以及项目名称都需改
抽项目，第三方分享，第三方登录，以及视频播放这些需要配置key值的功能，一定要确保key值配置正确，避免出现因为配置出错而增加维护时间；

5.第三方说明

一、基本流程使用的第三方

image.png

详细第三方单独更新在这里：
https://www.jianshu.com/p/fc0b727d3122

6.适配iPhone XR/iPhone XS Max
https://www.jianshu.com/p/d99e2fb36baa

7.iOS优化方案探究
https://www.jianshu.com/p/825d773c4a34