Android开发规范：JavaDoc

我的新书《Android App开发入门与实战》已于2020年8月由人民邮电出版社出版，欢迎购买。点击进入详情

JavaDoc的配置

JavaDoc的输出

Tools → Generate JavaDoc…

常见问题

错误: 编码GBK的不可映射字符
这是在utf-8项目中常会遇到的问题，其实也就是字符编码问题。
我们可以在VM的setting中进行如下设置：-encoding utf-8 -charset utf-8

使用gradle脚本

在目标project里面创建一个task：

task javadocJar(type: Javadoc) {
    source = project.android.sourceSets.main.java.srcDirs
    options.linkSource true
    classpath += project.files(project.android.getBootClasspath().join(File.pathSeparator))
    failOnError false
}

然后在gradle的tab里，找到这个工程中的javadocJar脚本，双击运行。

这样在项目的build目录下会自动创建javadoc文件：