此篇文章是介紹Java語(yǔ)言生成文檔過(guò)程，如果你用的是kotlin語(yǔ)言，請(qǐng)?zhí)D(zhuǎn)下面的鏈接查看生成文檔。http://www.itdecent.cn/p/27f1302a49f0?v=1673238889178

gRPC生成javadoc過(guò)程持續(xù)讓我找了好幾天，過(guò)程很費(fèi)勁且有點(diǎn)難記，所以在此記錄下來(lái)。以備后用。
1.首先proto文件配置的時(shí)候最好和主代碼的包名一致。

1.png

如紅色框里面的就要和你的代碼包名一致。后面生成javadoc方便。
2.如下圖，紅色框里是我的proto文件生成類都拷貝到代碼主包下。

2.png

。
藍(lán)色框里的代碼是我的主業(yè)務(wù)代碼。
綠色框里的是proto文件。
3.配置gradle
在你的Modul或app的gradle文件下配置

android {
    namespace 'com.vw.gamebasesdk'
    compileSdk 33

    defaultConfig {
     ...
    }

    buildTypes {
      ...
    }

    lintOptions {
        disable 'GoogleAppIndexingWarning', 'HardcodedText', 'InvalidPackage'
        textReport true
        textOutput "stdout"
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    tasks.withType(Javadoc) {
        failOnError false
        options.addStringOption('Xdoclint:none', '-quiet')
        options.addStringOption('encoding', 'UTF-8')
        options.addStringOption('charSet', 'UTF-8')
    }
}

task javaDoc(type: Javadoc) {
    delete("javadoc/") //清理舊的 javadoc
    options {
        encoding('UTF-8') //支持中文，避免亂碼
        charSet('UTF-8') //支持中文，避免亂碼
        memberLevel = JavadocMemberLevel.PUBLIC //保留 public 的方法
        linkSource true
        author false //是否保留作者
        noTree true //是否生成樹(shù)狀結(jié)構(gòu)
        noIndex true
        noNavBar true
    }
    source = android.sourceSets.main.java.srcDirs //生成 javadoc 的源目錄
    //模塊下的第三方庫(kù)的類名也能被索引{@link}，應(yīng)對(duì) javadoc 提示“錯(cuò)誤：找不到符號(hào)”
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    destinationDir = file("javadoc/") //生成 javadoc 的目標(biāo)目錄
    failOnError false //報(bào)錯(cuò)不中斷
}

afterEvaluate {
    javaDoc.classpath += files(android.libraryVariants.collect { variant ->
        variant.javaCompileProvider.get().classpath.files
    })
}

4.執(zhí)行Task
找到你的Gradle窗口，點(diǎn)擊下面的Task即可生成

4.png

有不成功的可以留言給我，我們一起學(xué)習(xí)成長(zhǎng)。