Android杂货——Android Studio javadoc 生成注释文档

相信大家刚开始写代码的时候就被前辈告知了要养成写注释的好习惯,今天我们来了解一下如何利用我们平时写的注释生成文档,我们一起来看看吧!

这里写图片描述

其实注释格式一般如下两种:
/*
*普通多行
*注释
*/
而我们需要生成文档就必须是下面这种格式:
/**
*javadoc
*要求格式
*/
其实就是多了一个*号而已。

既然了解了注释的格式,那么我们就利用上面的注释来使用android studio生成javadoc:
这里写图片描述
单击进入配置页面:
这里写图片描述
这里我主要讲以下几个地方:
首先在上面指定你需要生成文档的文件夹或文件;
然后是output directorys中指定输出文档的路径;
最后如果你注释中是中文就需要在Othere command line arguments中填写 -encoding utf-8 -charset utf-8 否则生成会失败并提示你“编码GBK的不可映射字符”,好了基本上流程就走完了,直接点击ok即可。
这里写图片描述

当你看到和我一样的界面那么你就成功了,我这里是生成了所有类的文档,如果没有自动打开网页,大家可以在我们指定的文档输出文件夹中找到index.html打开即可,好了本文就到此为止,希望对大家有用!

©️2020 CSDN 皮肤主题: 技术黑板 设计师:CSDN官方博客 返回首页