android studio kotlin接口文档导出

kotlin编写doc文档并导出

以前我们用java编写接口文档,编写后直接使用as自带的功能直接导出接口文档

在这里插入图片描述
在这里插入图片描述
这样直接会在目的地导出接口文档,但是当使用kotlin定义接口后,直接使用会报错:
在这里插入图片描述
于是我们采用另一种办法

使用官方推荐的dokka插件

如何使用呢
首先接入依赖在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")
//        }
//    }
}

就这么简单配置就好,然后直接在右侧的gradle里点击dcumentation下面的task dokkaJavaDoc 执行后就会在项目的本地根目录生成一份接口文档
在这里插入图片描述
打开里面的index.html就能查看接口文档

猜你喜欢

转载自blog.csdn.net/ligaoyuan8030/article/details/127511334