Skip to content

Commit 84da2ea

Browse files
committed
docs(Flutter): 格式优化
1 parent 502e076 commit 84da2ea

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

Flutter/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
**目录**
2-
- [DoKit Flutter版](#doKit-flutter版)
2+
- [DoKit Flutter版](#dokit-flutter版)
33
- [支持 Flutter 版本](#支持flutter版本)
44
- [Pub地址](#pub地址)
55
- [接入](#接入)
@@ -32,7 +32,7 @@ version>=1.17.5,其余版本未做过兼容性测试。支持 flutter2.0 的
3232
[DoKit For Flutter](https://pub.dev/packages/dokit)
3333

3434
## 接入
35-
1.在pubspect.yaml文件的dependencies节点添加pub依赖
35+
1.`pubspect.yaml` 文件的 dependencies 节点添加 pub 依赖
3636

3737
```yaml
3838
dependencies:
@@ -57,10 +57,10 @@ void main() => {
5757

5858
```
5959

60-
**注:谷歌提供的 DevTool 会折叠非主工程内实例化的widget(根据source file 是否属于当前工程),DoKit 需要实例化一个 wrapper widget 用以展示各种 overlay,
61-
如果在 package 内去声明这个 wrapper,会导致左边树全部被折叠。故这里要求在main文件内使用 DoKitApp(MyApp())的方式来初始化入口**
60+
**注:谷歌提供的 DevTool 会折叠非主工程内实例化的 widget(根据 source file 是否属于当前工程),DoKit 需要实例化一个 wrapper widget 用以展示各种 overlay,
61+
如果在 package 内去声明这个 wrapper,会导致左边树全部被折叠。故这里要求在 main 文件内使用 `DoKitApp(MyApp())` 的方式来初始化入口**
6262
另外提供了一个异步创建入口 Widget的方式,需要异步构建widget的情况。(有些库会在异步构建 Widget 的时候调用 WidgetFlutterBinding.ensureInitialized(),影响 DoKit的 method channel 监控和日志监控,需要延迟到 runZone 内执行)
63-
s
63+
6464
```dart
6565
void main() {
6666
DoKit.runApp(
@@ -97,38 +97,38 @@ releaseAction | Function | release模式下执行该函数,该值为空则会
9797

9898
<img src="https://pt-starimg.didistatic.com/static/starimg/img/AuETMp2dp11619684586454.png" width="300px" />
9999

100-
当前版本DoKit支持的所有功能全览。常驻工具为显示在底部tab栏的组件,可通过拖动将组件放置或移出常驻工具。
100+
当前版本 DoKit 支持的所有功能全览。常驻工具为显示在底部 tab 栏的组件,可通过拖动将组件放置或移出常驻工具。
101101

102102

103103
### 日志查看
104104

105105
<img src="https://pt-starimg.didistatic.com/static/starimg/img/apwIxs7A341609765573351.jpg" width="300px" />
106106

107107

108-
查看使用print方式打印出来的日志,捕获的异常会以红色显示。超过7行的日志会自动折叠,点击可展开。长按复制日志到剪贴板。
108+
查看使用 print 方式打印出来的日志,捕获的异常会以红色显示。超过7行的日志会自动折叠,点击可展开。长按复制日志到剪贴板。
109109

110110

111111
### 网络请求
112112

113113
<img src="https://pt-starimg.didistatic.com/static/starimg/img/nEN7uos9OV1609765604202.jpg" width="300px" />
114114

115115

116-
可以捕获通过flutter httpclient发出的网络请求,主流的http、dio库底层也是通过httpclient实现的,也能捕获。
116+
可以捕获通过 flutter httpclient 发出的网络请求,主流的 http、dio 库底层也是通过 httpclient 实现的,也能捕获。
117117

118118

119119
### Method Channel信息
120120

121121
<img src="https://pt-starimg.didistatic.com/static/starimg/img/qH6jtyNvqp1609765652146.jpg" width="300px" />
122122

123123

124-
可以展示从dart端到native和从native端到dart端的方法调用、参数、返回结果。
124+
可以展示从 dart 端到 native 和从 native 端到 dart 端的方法调用、参数、返回结果。
125125

126126
### 路由信息
127127

128128
<img src="https://pt-starimg.didistatic.com/static/starimg/img/VLyiReklD41609765682140.jpg" width="300px" />
129129

130130

131-
展示当前页面的路由信息,当存在多层Navigator组件嵌套时,会展示多层的路由信息。
131+
展示当前页面的路由信息,当存在多层 Navigator 组件嵌套时,会展示多层的路由信息。
132132

133133
**注:当前查找栈顶widget是通过遍历整棵widget tree的方式,如果添加了overlay,栈顶widget会始终指向overlay,导致该功能读取数据异常。**
134134

@@ -138,7 +138,7 @@ releaseAction | Function | release模式下执行该函数,该值为空则会
138138
<img src="https://pt-starimg.didistatic.com/static/starimg/img/Xno9FVbweg1609765703740.jpg" width="300px" />
139139

140140

141-
展示最近240帧的耗时情况,每次进入该页面刷新。debug模式下帧率会普遍偏高,profile和release模式下会比较正常
141+
展示最近240帧的耗时情况,每次进入该页面刷新。debug 模式下帧率会普遍偏高,profile 和 release 模式下会比较正常
142142

143143
### 内存
144144

@@ -154,7 +154,7 @@ releaseAction | Function | release模式下执行该函数,该值为空则会
154154
<img src="https://pt-starimg.didistatic.com/static/starimg/img/8brZZzWijZ1609765750681.jpg" width="300px" />
155155

156156

157-
展示当前dart虚拟机进程、cpu、版本信息;当前app包名和dart工程构建版本信息
157+
展示当前 dart 虚拟机进程、cpu、版本信息;当前 app 包名和 dart 工程构建版本信息
158158

159159
**注:该功能通过VMService获取数据,release模式下无法使用。flutter版本号需要flutter attach后才可获取**
160160

@@ -168,13 +168,13 @@ releaseAction | Function | release模式下执行该函数,该值为空则会
168168
### 颜色拾取
169169
<img src="https://pt-starimg.didistatic.com/static/starimg/img/4MYRNqqcZh1619673900891.png" width="300px" />
170170

171-
查看当前页面任何位置对应的像素点的RGBA颜色值,方便UI的调试和获取像素点的颜色
171+
查看当前页面任何位置对应的像素点的 RGBA 颜色值,方便UI的调试和获取像素点的颜色
172172

173173
### Widget层级
174174
<img src="https://pt-starimg.didistatic.com/static/starimg/img/GmjvVDp4Ye1619673908393.png" width="300px" />
175175
<img src="https://pt-starimg.didistatic.com/static/starimg/img/sGd73y7uoc1619673910771.png" width="300px" />
176176

177-
查看当前选中widget的树层级,以及它renderObject的详细build链等信息
177+
查看当前选中 widget 的树层级,以及它 renderObject 的详细 build 链等信息
178178

179179
### 页面源码查看
180180
<img src="https://pt-starimg.didistatic.com/static/starimg/img/e7Pbo95nJ71619665430550.jpg" width="300px" />
@@ -188,7 +188,7 @@ releaseAction | Function | release模式下执行该函数,该值为空则会
188188
<img src="https://pt-starimg.didistatic.com/static/starimg/img/z1wWlYqZDg1619674872051.png" width="300px" />
189189

190190
获取页面的启动耗时,
191-
框架已做无侵入的注入NavigatorObserver。但是在较复杂的App构建时可能失效,需要手动添加`DokitNavigatorObserver`
191+
框架已做无侵入的注入 NavigatorObserver。但是在较复杂的 App 构建时可能失效,需要手动添加`DokitNavigatorObserver`
192192

193193
**注:页面启动耗时信息只有在profile或release模式下才有意义**
194194

0 commit comments

Comments
 (0)