java Doc文档生成方式

Java Doc

Javadoc命令是用来生产自己API文档的

参数信息

• @author作者名
• @version 版本号
• @since 指明需要最早使用的JDK版本
• @param参数名
• @return返回值情况
• @throws异常抛出情况

idea生成javadoc文档

1.idea上方选择Tools->Generate JavaDoc

• 1.选择整个项目还是单个模块

• 2.生成文档放的位置

• 3.选择地区语言 zh-CN（中文）

• 4.-encoding UTF-8 -charset UTF-8 -author -version -windowtitle " "

  注意参数里面的“ ”里面就是你生成的JavaDoc存放的指定目录（就是2）

然后点ok即可

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ZohqBxLe-1645325543290)(D:\浏览器下载内容\csdn2.png)]

cmd生成javaDoc文档

1.右键需要生成的项目->show in explorer[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-XQaN6HdG-1645325543290)(D:\浏览器下载内容\csdn3.png)]

2.在该路径前加cmd (和路径中间有空格)

3.在cmd中输入 javadoc -encoding UTF-8 -charset UTF-8 Doc.java(需要生成的项目名)

(有中文需要转成UTF-8)

若出现‘javadoc‘ 不是内部或外部命令，也不是可运行的程序 或批处理文件。则是环境变量没有配置，配置环境变量即可