Merge pull request didi#1021 from mengyanshou/master

docs(Flutter) : 整体格式优化，添加目录，代码颜色高亮

Flutter/README.md

@@ -1,62 +1,83 @@
+**目录**
+- [DoKit Flutter版](#dokit-flutter版)
+- [支持 Flutter 版本](#支持flutter版本)
+- [Pub地址](#pub地址)
+- [接入](#接入)
+- [功能简介](#功能简介)
+  - [全部组件](#全部组件)
+  - [日志查看](#日志查看)
+  - [网络请求](#网络请求)
+  - [Method Channel信息](#method-channel信息)
+  - [路由信息](#路由信息)
+  - [帧率](#帧率)
+  - [内存](#内存)
+  - [基本信息](#基本信息)
+  - [控件检查](#控件检查)
+  - [颜色拾取](#颜色拾取)
+  - [Widget层级](#widget层级)
+  - [页面源码查看](#页面源码查看)
+  - [页面启动耗时](#页面启动耗时)
+  - [自定义入口](#自定义入口)
+
 # DoKit Flutter版
 
-内测版本，目前提供了日志、method channel信息、路由信息、网络抓包、帧率、设备与内存信息查看、控件信息查看、颜色拾取、启动耗时、查看源码、查看widget的build链以及对齐标尺的功能.
+内测版本，目前提供了日志、method channel 信息、路由信息、网络抓包、帧率、设备与内存信息查看、控件信息查看、颜色拾取、启动耗时、查看源码、查看 widget 的 build 链以及对齐标尺的功能.
+
+## 支持Flutter版本
 
-## 支持flutter版本
-version>=1.17.5，其余版本未做过兼容性测试。支持flutter2.0的分支为`0.8.0-nullsafety.0`，后期维护主要会基于该版本进行。
+version>=1.17.5，其余版本未做过兼容性测试。支持 flutter2.0 的分支为`0.8.0-nullsafety.0`，后期维护主要会基于该版本进行。
 
 ## Pub地址
+
 [DoKit For Flutter](https://pub.dev/packages/dokit)
 
 ## 接入
-在pubspect.yaml文件的dependencies节点添加pub依赖
+1.在 `pubspect.yaml` 文件的 dependencies 节点添加 pub 依赖
 
-```
+```yaml
 dependencies:
   dokit: ^0.8.0-nullsafety.0
 ```
 
-在main函数入口初始化。 DoKit使用runZone的方式进行日志捕获，方法通道的捕获，如果你的app需要使用同样的方式会有冲突。
+2.在 main 函数入口初始化。 DoKit 使用 runZone 的方式进行日志捕获，方法通道的捕获，如果你的 app 需要使用同样的方式会有冲突。
 
-```
+```dart
 void main() => {
-
-      DoKit.runApp(app:DoKitApp(MyApp()),
-          // 是否在release包内使用，默认release包会禁用
-          useInRelease: true,
-          // 选择性控制是否使用dokit中的runZonedGuarded,false: 禁用；true: 启用
-          useRunZoned: false,
-          releaseAction: () => {
-              // release模式下执行该函数，一些用到runZone之类实现的可以放到这里，该值为空则会直接调用系统的runApp(MyApp())，
-              })
-    };
+  DoKit.runApp(
+    app: DoKitApp(const MyApp()),
+    // 是否在release包内使用，默认release包会禁用
+    useInRelease: true,
+    // 选择性控制是否使用dokit中的runZonedGuarded,false: 禁用；true: 启用
+    useRunZoned: false,
+    releaseAction: () => {
+      // release模式下执行该函数，一些用到runZone之类实现的可以放到这里，该值为空则会直接调用系统的runApp(MyApp())，
+    },
+  );
 }
 
 ```
 
-**注：谷歌提供的DevTool会折叠非主工程内实例化的widget（根据source file是否属于当前工程），DoKit需要实例化一个wrapper widget用以展示各种overlay，
-      如果在package内去声明这个wrapper，会导致左边树全部被折叠。故这里要求在main文件内使用DoKitApp(MyApp())的方式来初始化入口**
-
+**注：谷歌提供的 DevTool 会折叠非主工程内实例化的 widget（根据 source file 是否属于当前工程），DoKit 需要实例化一个 wrapper widget 用以展示各种 overlay，
+如果在 package 内去声明这个 wrapper，会导致左边树全部被折叠。故这里要求在 main 文件内使用 `DoKitApp(MyApp())` 的方式来初始化入口**
+另外提供了一个异步创建入口 Widget的方式，需要异步构建widget的情况。(有些库会在异步构建 Widget 的时候调用 WidgetFlutterBinding.ensureInitialized()，影响 DoKit的 method channel 监控和日志监控，需要延迟到 runZone 内执行)
+
+```dart
+void main() {
+  DoKit.runApp(
+    appCreator: () async => DoKitApp(
+      await crateApp(),
+    ),
+  );
+}
 
- 另外提供了一个异步创建入口Widget的方式，需要异步构建widget的情况。(有些库会在异步构建Widget的时候调用WidgetFlutterBinding.ensureInitialized()，影响DoKit的method channel监控
- 和日志监控，需要延迟到runZone内执行)
-```
-void main() => {
-       DoKit.runApp(
-             appCreator: () async =>
-                 DoKitApp(await crateApp())));
-    };
-
- Widget crateApp() async{
-   // 一些初始化操作
-   await ...
-   return MyApp();
- }
+Future<Widget> crateApp() async {
+  // 一些初始化操作
+  return MyApp();
 }
 ```
 
 
-### 参数说明
+**参数说明**
 
 
 参数 | 返回类型 | 说明 | 是否必须
@@ -76,38 +97,38 @@ releaseAction | Function | release模式下执行该函数，该值为空则会
 
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/AuETMp2dp11619684586454.png"  width="300px"  />
 
-当前版本DoKit支持的所有功能全览。常驻工具为显示在底部tab栏的组件，可通过拖动将组件放置或移出常驻工具。
+当前版本 DoKit 支持的所有功能全览。常驻工具为显示在底部 tab 栏的组件，可通过拖动将组件放置或移出常驻工具。
 
 
 ### 日志查看
 
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/apwIxs7A341609765573351.jpg"  width="300px"  />
 
 
-查看使用print方式打印出来的日志，捕获的异常会以红色显示。超过7行的日志会自动折叠，点击可展开。长按复制日志到剪贴板。
+查看使用 print 方式打印出来的日志，捕获的异常会以红色显示。超过7行的日志会自动折叠，点击可展开。长按复制日志到剪贴板。
 
 
 ### 网络请求
 
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/nEN7uos9OV1609765604202.jpg"  width="300px"  />
 
 
-可以捕获通过flutter httpclient发出的网络请求，主流的http、dio库底层也是通过httpclient实现的，也能捕获。
+可以捕获通过 flutter httpclient 发出的网络请求，主流的 http、dio 库底层也是通过 httpclient 实现的，也能捕获。
 
 
 ### Method Channel信息
 
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/qH6jtyNvqp1609765652146.jpg"  width="300px"  />
 
 
-可以展示从dart端到native和从native端到dart端的方法调用、参数、返回结果。
+可以展示从 dart 端到 native 和从 native 端到 dart 端的方法调用、参数、返回结果。
 
 ### 路由信息
 
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/VLyiReklD41609765682140.jpg"  width="300px"  />
 
 
-展示当前页面的路由信息，当存在多层Navigator组件嵌套时，会展示多层的路由信息。
+展示当前页面的路由信息，当存在多层 Navigator 组件嵌套时，会展示多层的路由信息。
 
 **注：当前查找栈顶widget是通过遍历整棵widget tree的方式，如果添加了overlay，栈顶widget会始终指向overlay，导致该功能读取数据异常。**
 
@@ -117,7 +138,7 @@ releaseAction | Function | release模式下执行该函数，该值为空则会
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/Xno9FVbweg1609765703740.jpg"  width="300px"  />
 
 
-展示最近240帧的耗时情况，每次进入该页面刷新。debug模式下帧率会普遍偏高，profile和release模式下会比较正常。
+展示最近240帧的耗时情况，每次进入该页面刷新。debug 模式下帧率会普遍偏高，profile 和 release 模式下会比较正常。
 
 ### 内存
 
@@ -133,7 +154,7 @@ releaseAction | Function | release模式下执行该函数，该值为空则会
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/8brZZzWijZ1609765750681.jpg"  width="300px"  />
 
 
-展示当前dart虚拟机进程、cpu、版本信息；当前app包名和dart工程构建版本信息；
+展示当前 dart 虚拟机进程、cpu、版本信息；当前 app 包名和 dart 工程构建版本信息；
 
 **注：该功能通过VMService获取数据，release模式下无法使用。flutter版本号需要flutter attach后才可获取**
 
@@ -147,13 +168,13 @@ releaseAction | Function | release模式下执行该函数，该值为空则会
 ### 颜色拾取
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/4MYRNqqcZh1619673900891.png"  width="300px"  />
 
-查看当前页面任何位置对应的像素点的RGBA颜色值，方便UI的调试和获取像素点的颜色
+查看当前页面任何位置对应的像素点的 RGBA 颜色值，方便UI的调试和获取像素点的颜色
 
 ### Widget层级
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/GmjvVDp4Ye1619673908393.png"  width="300px"  />
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/sGd73y7uoc1619673910771.png"  width="300px"  />
 
-查看当前选中widget的树层级，以及它renderObject的详细build链等信息
+查看当前选中 widget 的树层级，以及它 renderObject 的详细 build 链等信息
 
 ### 页面源码查看
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/e7Pbo95nJ71619665430550.jpg"  width="300px"  />
@@ -167,7 +188,7 @@ releaseAction | Function | release模式下执行该函数，该值为空则会
 <img src="https://pt-starimg.didistatic.com/static/starimg/img/z1wWlYqZDg1619674872051.png"  width="300px"  />
 
 获取页面的启动耗时, 
-框架已做无侵入的注入NavigatorObserver。但是在较复杂的App构建时可能失效，需要手动添加`DokitNavigatorObserver`
+框架已做无侵入的注入 NavigatorObserver。但是在较复杂的 App 构建时可能失效，需要手动添加`DokitNavigatorObserver`
 
 **注：页面启动耗时信息只有在profile或release模式下才有意义**