小知识,大挑战!本文正在参与“ 程序员必备小知识 ”创作活动
本文同时参与 「掘力星计划」 ,赢取创作大礼包,挑战创作激励金
一. 概述
我们知道使用Java代码书写的Android项目,可以直接用Android studio自带的JavaDoc生成工具自动生成(
Tools —> Generate JavaDoc
),那么使用Kotlin语言书写的Android studio项目和使用Kotlin和java混合开发的android项目呢,可不可以使用JavaDoc生成工具自动生成说明文档??? 答案:不能
二. kotin项目文档生成工具Dokka
Android studio自带工具可以生成文档吗?
Android studio 自带的Generate JavaDoc
可以生成纯Java项目和kotkin和Java混合项目中的Java代码部分
无法生成kotlin代码输入的项目文档
kotlin项目如何生成文档
- 这里可以使用GitHub上的一个文档生成工具Dokka
- Dokka不仅可以生成纯kotlin项目
- 还可以生成kotlin和Java混合开发的项目,并生成文档
- Dokka支持多种格式输出(html,javadoc,markdown..)
三. 项目中Dokka的配置
1.在project的build.gradle中添加仓库和依赖
buildscript {
repositories {
maven { url 'http://maven.aliyun.com/nexus/content/groups/public/' }
// 或者jcenter()
......
}
dependencies {
......
classpath 'org.jetbrains.dokka:dokka-gradle-plugin:0.10.1'
}
}
2.在app的build.gradle中添加插件以及配置dokka参数
apply plugin: 'org.jetbrains.dokka'
android {
......
dokka {
outputFormat = 'javadoc'
outputDirectory = "$buildDir/dokka"
configuration {
// Do not output deprecated members
skipDeprecated = true
// Emit warnings about not documented members.
reportUndocumented = true
// Do not create index pages for empty packages
skipEmptyPackages = true
noJdkLink = true
noStdlibLink = true
noAndroidSdkLink = true
}
}
}
dependencies {
......
}
按上图配置完成后,sync
同步项目即可完成配置
四. 如何使用Dokka生成文档
4.1 通过右侧Gradle窗口中Document中的dokka
- 打开右侧的Gradle窗口,然后通过
项目名 --> app --> Tasks --> documentation --> dokka
找到该任务,双击
运行任务
graph LR
1{{Gradle窗口}}-->A[项目名] --> B[app] --> C[Tasks] -->D[documentation ] -->E{dokka}
4.2 在terminal
窗口中输入./gradlew dokka
运行任务
- 打开底部Terminal窗口,在窗口中输入gradlew dokka执行任务
五. 查看Dokka生成文档
依次打开:项目—>app—>build—>dokka(build.gradle中配置生成文件夹)—>右键使用浏览器打开index.html