android studio 使用JavaDoc生成说明文档

本文介绍如何通过IDE生成Java项目的JavaDoc文档,并解决中文注释乱码及环境变量配置问题。

在编写一个依赖库的时候,我们可能需要打成aar包出来,供他人使用,这时候生成说明文档是很有必要的。至于注释,这里就不做说明了。

直接进入主题吧。。。

首先选择Tools -> Generate JavaDoc

出来下面这个界面

我们可能需要填写上图标红的部分的值, Ouput Directory : 选择我们将生成的文档的存放位置。

Other command  line arguments: 如果我的注释有中文,那么我们需要指定一下字符编码。

-encoding utf-8 -charset utf-8

直接点击 OK,就可以生成说明文档了到我们指定的位置了。

注意:这时候可能会报错,通常情况下只会报这个错:

java.lang.IllegalArgumentException 

    at sun.net.www.ParseUtil.decode(ParseUtil.java:202)

...

这里其实是我们的环境 变量配置的问题,在以往我们配置JDK环境变量时,会配置一个CLASSPATH,里面的值一般都是引用%JAVA_HOME%,我们需要修改这个配置

将CLASSPATH改为具体的路径值,如:C:\Program Files\Java\jdk1.7.0_80\jre\lib,当然,这是我电脑安装JDK的路径,你需要改你自己电脑JDK的安装路径,重启IDE后生效,如果无效,请重启电脑。

见官方参考文档 http://maven.apache.org/plugins/maven-javadoc-plugin/faq.html 

 

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值