一 概述
我们知道使用Java代码书写的Android项目，可以直接用Android studio自带的JavaDoc生成工具自动生成(Tools—>Generate JavaDoc)，那么使用Kotlin语言书写的Android studio项目和使用Kotlin和java混合开发的android项目呢，可不可以使用JavaDoc生成工具自动生成说明文档？？？
二 kotin项目文档生成工具Dokka
2.1 Android studio自带工具可以生成文档吗
- Android studio 自带的Generate JavaDoc可以生成纯Java项目和kotkin和Java混合项目中的Java代码部分
- 无法生成kotlin代码输入的项目文档
2.2 kotlin项目如何生成文档
- 这里可以使用GitHub上的一个文档生成工具Dokka
- Dokka不仅可以生成纯kotlin项目
- 还可以生成kotlin和Java混合开发的项目，并生成文档
- Dokka支持多种格式输出(html,javadoc,markdown..)
三 项目中Dokka的配置
-
在project的build.gradle中添加仓库和依赖
复制1 2 3 4 5 6 7 8 9 10 11
buildscript { repositories { ...... google() jcenter() } dependencies { ...... classpath 'org.jetbrains.dokka:dokka-gradle-plugin:0.10.1' } } -
在app的build.gradle中添加插件以及配置dokka参数(方式一和方式二任选其一)
复制1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
apply plugin: 'org.jetbrains.dokka' android { ...... dokka { // 输出格式，目前支持五种，html, javadoc,html-as-java, markdown,kotlin-website* outputFormat = 'javadoc' // 文档输出目录(app/build/dokka) outputDirectory = "$buildDir/dokka" //配置方式一 configuration { noJdkLink = true noStdlibLink = true noAndroidSdkLink = true skipDeprecated = true // Do not output deprecated members reportUndocumented = true // Emit warnings about not documented members. skipEmptyPackages = true // Do not create index pages for empty packages } //配置方式二 configuration { noJdkLink = true noStdlibLink = true noAndroidSdkLink = true externalDocumentationLink { url = new URL("https://developer.android.google.cn/reference/") packageListUrl = new URL("https://developer.android.google.cn/reference/package-list") //packageListUrl = new URL("file:///${rootDir}/package-list") } } } } dependencies { ...... } -
按上图配置完成后，同步项目即可完成配置
四 如何使用Dokka生成文档
4.1 通过右侧Gradle窗口中Document中的dokka
- 打开右侧的
Gradle窗口，然后通过项目名 --> app --> Tasks --> documentation --> dokka找到该任务，双击运行任务
4.2 在terminal窗口中输入./gradlew dokka运行任务
- 打开底部Terminal窗口，在窗口中输入
./gradlew dokka执行任务
五 查看Dokka生成文档
- 依次打开：项目—>app—>build—>dokka(build.gradle中配置生成文件夹)—>右键使用浏览器打开
index.html
六 参考
