IDEA在工具/生成JavaDoc是一个非常方便生成JavaDoc帮助文档的工具
但是在生成JavaDoc的时候经常会遇到一些问题:
1.错误运行’Javadoc 问题’: 未指定JDK路径 不能生成JavaDoc
解决方案:可能是由于IDEA内置的默认jdk的版本比较低,对一些方法和类不能支持,需要我们指定自己的JDK路径
打开 文件/项目接口,进入SDK设置
选择项目SDK为我们自己的SDK,如果没有添加的话,点击Add SDK 添加我们自己的SDK即可解决这个问题
2.错误: 编码 GBK 的不可映射字符
这个问题常在Window操作环境下发生,特别是中文版Windows,因为IDEA在生成Javadoc时候会获取操作系统默认的编码格式,Windows对于汉字默认使用GBK编码,而在IDEA中通常是UTF-8编码,通常就会产生 GBK 的不可映射字符问题
解决方案很简单
在生成Javadoc的时候加上参数-encoding utf-8 -charset utf-8 即可,表示使用UTF-8进行编码
-encoding utf-8 -charset utf-8
然后就能正确生成Javadoc ,其中的警告: @param 没有说明 之类的不必担心,这是我们漏写了一些Javadoc内容导致一些Javadoc有些内容没有填写
生成效果如图所示: