使用Gradle生成Kotlin代码文档

r囧r小猫 2022-04-23 06:24 309阅读 0赞

# Kotlin项目 #

在 **Root Project** 下的 `build.gradle` 文件中 `buildscript` 下的 `dependencies` 中添加：

classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.15"

在 **module** 下的 `build.gradle` 文件中添加：

apply plugin: 'org.jetbrains.dokka'
    
    
    task generateSourcesJar(type: Jar) {
        group = 'jar'
        from sourceSets.main.java.srcDirs
        classifier = 'sources'
    }
    
    task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
        outputFormat = "javadoc"
        outputDirectory = javadoc.destinationDir
    }
    
    task generateJavadoc(type: Jar, dependsOn: dokkaJavadoc) {
        group = 'jar'
        classifier = 'javadoc'
        from javadoc.destinationDir
    }
    
    artifacts {
        archives generateJavadoc
        archives generateSourcesJar
    }

其中， `generateSourcesJar` Task 中的 `from sourceSets.main.java.srcDirs` 需要根据项目实际源码目录填写。

同步之后，在 `gradle` 的任务列表中的 `jar` 分组下就可以看到 `generateSourcesJar` 和 `generateJavadoc` 两个任务了。  
双击这两个任务，`sources.jar` 和 `javadoc.jar` 就会生成，位置在 `build/libs` 目录下。

# 使用Kotlin开发的Android项目 #

在 **Root Project** 下的 `build.gradle` 文件中 `buildscript` 下的 `dependencies` 中添加：

classpath 'org.jetbrains.dokka:dokka-android-gradle-plugin:0.9.15'

在 **module** 下的 `build.gradle` 文件中添加：

apply plugin: 'org.jetbrains.dokka-android'
    
    
    task generateSourcesJar(type: Jar) {
        group = 'jar'
        from android.sourceSets.main.java.srcDirs
        classifier = 'sources'
    }
    
    task javadoc(type: Javadoc) {
        source = android.sourceSets.main.java.srcDirs
        classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    }
    
    task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
        outputFormat = "javadoc"
        outputDirectory = javadoc.destinationDir
    }
    
    task generateJavadoc(type: Jar, dependsOn: dokkaJavadoc) {
        group = 'jar'
        classifier = 'javadoc'
        from javadoc.destinationDir
    }
    
    artifacts {
        archives generateJavadoc
        archives generateSourcesJar
    }

其中， `generateSourcesJar` Task 和 `javadoc` Task 中的 `sourceSets.main.java.srcDirs` 需要根据项目实际源码目录填写。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70 1][]

也可以使用命令：

打开Termina

分别执行

gradlew  generateSourcesJar

gradlew  generateJavadoc

成功后，在module下的build目录libs下就能看到两个jar包

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70 2][]  
打开app-javadoc.jar即可看到生成的文档

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70 3][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70 4][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190124161001349.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70 1]: /images/20220323/4411822cafd5412c8b248961b7700286.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70 2]: /images/20220323/5dbf2c44a4fa4ee096a47bd5069930e1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70 3]: /images/20220323/3ea2e7beec9f41d293e5aaa4262924cb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhbmxlaXlt_size_16_color_FFFFFF_t_70 4]: /images/20220323/ff5c81bb90614ec09a8638fab92602a7.png