Kotlin escreve documentos doc e os exporta
No passado, usávamos java para escrever documentos de interface e, depois de escrever, usávamos diretamente as funções que acompanhavam para exportar documentos de interface diretamente
Isso exportará diretamente o documento da interface no destino, mas ao usar o kotlin para definir a interface, um erro será relatado se for usado diretamente:
então adotamos outro método
Use o plug-in dokka oficialmente recomendado
Como usar
Primeiro, a dependência de acesso é integrada no app gradle
buildscript {
...
dependencies {
...
classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.7.20")
}
}
plugins {
...
id("org.jetbrains.dokka") version "1.7.20"
}
...
dependencies {
...
dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
}
// 配置导出信息
tasks.dokkaJavadoc.configure {
// 导出的文档目录路径
outputDirectory.set(new File(rootDir, "doc"))
// dokkaSourceSets {
// named("main") {
// noAndroidSdkLink.set(true)
// noStdlibLink.set(true)
// noJdkLink.set(true)
// }
// configureEach {
// // 包的定义
// includes.from("packages.md")
// }
// }
}
Basta configurá-lo tão simples quanto isso e clicar diretamente na tarefa dokkaJavaDoc em dcumentation no gradle à direita. Após a execução, um documento de interface será gerado no diretório raiz local do projeto. Abra o index.html dentro para visualizar o
documento de interface