如何基于Gradle7.4在Azure DevOps流水线为多Flavor Android项目生成Javadoc？

步骤1：修改app模块的build.gradle文件 #

在app目录下的build.gradle（Groovy）或build.gradle.kts（Kotlin）中添加Javadoc任务配置，确保和Azure DevOps中指定的docs任务关联：

Groovy版本 #

android {
    // 保留原有Android配置...

    // 定义生成Javadoc的核心任务
    task generateJavadoc(type: Javadoc) {
        // 指定Android项目的主源码目录
        source = android.sourceSets.main.java.srcDirs
        // 引入Android SDK的类路径，避免Javadoc找不到Android相关类
        classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
        // 排除无需生成文档的文件/目录，比如自动生成的R类、BuildConfig以及测试代码
        exclude '**/R.java', '**/BuildConfig.java', '**/test/**'
        
        // 设置Javadoc的输出目录，可按需修改
        destinationDir = file("$buildDir/docs/javadoc")
        
        // 配置Javadoc生成参数
        options {
            encoding 'UTF-8'
            charSet 'UTF-8'
            // 自定义文档标题
            title = "你的应用名称Javadoc"
            // 忽略不必要的警告，避免任务因非致命警告失败
            addStringOption('Xdoclint:none', '-quiet')
        }
    }

    // 定义Azure DevOps中调用的docs任务，依赖上面的generateJavadoc任务
    task docs(dependsOn: generateJavadoc) {
        // 空任务，仅作为执行入口
    }
}

Kotlin版本 #

android {
    // 保留原有Android配置...

    // 注册生成Javadoc的核心任务
    val generateJavadoc by tasks.registering(Javadoc::class) {
        source = android.sourceSets.main.java.srcDirs
        classpath += files(android.bootClasspath.joinToString(File.pathSeparator))
        exclude("**/R.java", "**/BuildConfig.java", "**/test/**")
        
        destinationDir = file("$buildDir/docs/javadoc")
        
        options {
            encoding = "UTF-8"
            charSet = "UTF-8"
            title = "你的应用名称Javadoc"
            addStringOption("Xdoclint:none", "-quiet")
        }
    }

    // 定义docs任务，关联generateJavadoc任务
    tasks.register("docs") {
        dependsOn(generateJavadoc)
    }
}

步骤2：验证Azure DevOps任务配置 #

你当前的Gradle任务配置基本可用，需注意两个细节：

• 确认$(workingDirectory)变量指向项目根目录（即包含gradlew文件的目录）
• JDK版本选择1.11（Java 11）需和你的Android Gradle Plugin版本兼容（AGP 7.0及以上支持Java 11）

步骤3：发布Javadoc产物（可选） #

如果需要将生成的Javadoc保存为构建产物，可在Azure DevOps任务中添加Publish Build Artifacts步骤：

- task: PublishBuildArtifacts@1
  displayName: Publish Javadoc Artifacts
  inputs:
    PathtoPublish: '$(workingDirectory)/app/build/docs/javadoc'
    ArtifactName: 'javadoc'
    publishLocation: 'Container'

内容的提问来源于stack exchange，提问作者Ravichandra V