Android开发规范：JavaDoc

最新推荐文章于 2023-07-17 23:57:53 发布

原创最新推荐文章于 2023-07-17 23:57:53 发布 · 669 阅读

0 ·

CC 4.0 BY-SA版权

本文为博主原创文章，未经博主允许不得转载。

文章标签：

#javadoc

Android 同时被 2 个专栏收录

152 篇文章

订阅专栏

Android--规范

22 篇文章

订阅专栏

本书《AndroidApp开发入门与实战》于2020年8月由人民邮电出版社出版，适合初学者和实战开发者。本文还详细介绍了JavaDoc的配置方法，包括如何解决字符编码问题，以及如何使用gradle脚本自动生成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文件：