文档生成

先决条件

• 已经按照文档配置了项目
  • Androidx配置
  • 非Androidx配置
• 需要配置 Gradle 插件

生成文档步骤

1.配置文档目录 比如下面这样

2.配置注解驱动器生成文件的目录为上面的参数

在你想要生成文档的各个模块的 build.gradle 中配置注解驱动器的属性.

3.构建项目 因为上面你改了 build.gradle 的内容, 所以需要构建一下

4.清空文档目录

在配置了 Gradle 文档后, 右侧的 Gradle 菜单中会有一个名为 component 的组. 双击 routerDocClean 完成清理

5.Rebuild Project

整个重新构建, 生成路由文档的 json 信息. 效果如下

6.生成Html文档

点击 Gradle 菜单中的 routerDoc, 会生成一个 Html 文件. 打开它即是文档的全部

7.善后处理

由于生成的目录是你自己指定的, 如果你选择了项目的某个路径. 那么生成的文件就会在 git 的工作空间中. 如果你生成的文档不想进行版本控制. 还请自行忽略.