Android Studio导入Maven库无Kdoc文档 已配置Dokka仍不生效怎么办

核心配置修正 #

你当前的发布脚本存在2个关键遗漏，按下方步骤修改即可：

1. 补全源码包的文件范围 #

你现有androidSourcesJar任务仅收集了Java源文件，未包含Kotlin源码，Android Studio优先读取源码包内的Kdoc注释，缺少Kotlin源码会直接导致文档无法加载：

task androidSourcesJar(type: Jar) {
    archiveClassifier.set('sources')
    // 同时包含Java、Kotlin源目录
    from android.sourceSets.main.java.srcDirs
    from kotlin.sourceSets.main.kotlin.srcDirs
}

2. 显式配置Dokka任务的源集规则 #

需确保Dokka任务能完整收集所有Kdoc内容，避免遗漏Kotlin文件的注释：

// 追加到发布脚本同文件内即可
tasks.withType(org.jetbrains.dokka.gradle.DokkaJavadocTask).configureEach {
    dokkaSourceSets {
        named("main") {
            sourceRoots.from(android.sourceSets.main.java.srcDirs)
            sourceRoots.from(kotlin.sourceSets.main.kotlin.srcDirs)
            includeNonPublic.set(false) // 按需开启非公开成员的文档生成
            skipEmptyPackages.set(true)
        }
    }
}

额外校验规则 #

• 确保模块级build.gradle已正确引入Dokka插件，插件版本需与项目Kotlin版本大版本对齐，示例：

  plugins {
      id 'com.android.library'
      id 'org.jetbrains.kotlin.android'
      id 'org.jetbrains.dokka' version '1.9.20' // 与Kotlin版本匹配
      id 'maven-publish'
  }
  

• 到Maven仓库对应包路径下确认文件命名符合规范：需存在[artifactId]-[version]-sources.jar、[artifactId]-[version]-javadoc.jar两个构件，命名异常会导致Android Studio无法识别
• Android Studio端需开启自动下载文档配置：打开Settings -> Build, Execution, Deployment -> Build Tools -> Gradle，勾选Automatically download下的Sources、Documentation选项，修改后清理缓存重启：File -> Invalidate Caches -> 勾选清除文件系统缓存 -> 重启同步Gradle
• Gradle 7.0+版本可追加版本映射配置，避免构件命名被自动篡改：

  publishing {
      publications.withType(MavenPublication) {
          versionMapping {
              usage('java-api') {
                  fromResolutionOf('runtimeClasspath')
              }
              usage('java-runtime') {
                  fromResolutionResult()
              }
          }
      }
      // 保留你原有发布配置
  }
  

内容的提问来源于stack exchange，提问作者Emanuel Amiguinho