使用IDEA生成JavaDoc文档(2种方法)

方法一:用idea自带工具

1. 在IDEA中选择工具(Tool)选项卡打开并选择Generate JavaDoc(生成javaDoc)

使用IDEA生成JavaDoc文档(2种方法)_第1张图片

2.配置各种参数

使用IDEA生成JavaDoc文档(2种方法)_第2张图片
图片借鉴地址:https://blog.csdn.net/qq_44122193/article/details/114789427.

  1. 第一步:选择生成JavaDoc文档的范围,我只对一个源文件生成Doc,所以选择文件。
  2. 第二步:输出目录最好新建一个文件夹,比较有条理和整洁
  3. 第三步:区域设置,决定文档的语言,简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww
  4. 第四步:其他命令行参数:如果区域设置为中国,参数一般为
    -encoding UTF-8 -charset UTF-8 主要意义是为了显示中文不出现乱码
  5. 第五步:设置完成后点击确定即可生成Doc文档

3.查看生成文档

打开输出目录,就可看到成功生成,打开 index.html 便能看生成的文档。
使用IDEA生成JavaDoc文档(2种方法)_第3张图片

方法二:命令行窗口生成javaDoc

1.打开cmd,并切换当前文件夹到要生成javaDoc文档的文件所在文件夹

我这边直接打开目标文件夹,路径前加入cmd (记得空格)然后回车键就打开了当前文件夹为此的命令行窗口
在这里插入图片描述
使用IDEA生成JavaDoc文档(2种方法)_第4张图片

2.输入指令

输入以下指令javaDoc -encoding UTF-8 -charset UTF-8 hello.java
指令内容对应的意义在方法一中可以找到
回车!
然后会出现使用IDEA生成JavaDoc文档(2种方法)_第5张图片
表示成功

3.查看生成文档

默认输出到当前文件夹,打开目标目录可以看到
使用IDEA生成JavaDoc文档(2种方法)_第6张图片
打开 index.html 便能看生成的文档

你可能感兴趣的:(使用IDEA生成JavaDoc文档(2种方法))