JavaDoc文档的生成(命令行,Eclipse,IDEA)
通过命令行生成javadoc
-
首先进入要生成javadoc 的目标.java文件的目录下中打开cmd
进入cmd的方法
-
然后在命令行中输入命令 javadoc xxx.java
即可生成对应文档,生成的文档在当前目录下,可查看其中的index.html
-
在生成过程中可能出现编码格式错误如下图所示
出现该问题的原因是你的java类中包含了中文字符,可以通过设置编码格式,和字符编码格式来解决此问题,都可以设置为utf-8
命令:javadoc -encoding UTF-8 -charset UTF-8 xxx.java
在Eclipse中生成JavaDoc
- Eclipse的导航栏->Project->Generate Javadoc…
- 依次执行以下步骤依次选择next,最后finish
最终结果查看
在IDEA中生成JavaDoc
- IDEA导航栏->Tools->Generate->JavaDoc…
- 选项设置
- 最后在指定的路径中查看文档