IDEA生成Java Doc帮助文档

使用场景

使用IDEA(本次使用2020.3版)将自己写的常用的工具类打成jar包,安装到maven本地仓库,最后生成对应的doc参考文档。

操作流程

方法一

选中项目 右键 show in Explor,如下图:

选中地址栏 cmd

输入命令 javadoc -encoding UTF-8 -charset UTF-8 xxx.java

最终会在目录下生成一些html静态文件说明生成成功。

方法二

使用idea生成

  1. (选中要生成文档的类或者源码包)找到工具栏tools --> Gencrate JavaDoc...打开, 如下图:
  1. 在弹出的窗口主要进行三步

第一步:包所在目录,如果已选中 这里不用选择;

第二步:输入要输出文件的地址,及帮助文档输出地址;

第三步:输入语言环境为中文:zh_CN

第四步:输入命令行参数: -encoding UTF-8 -charset UTF-8

  1. 点击ok(生成成功)完成后如下图:
相关推荐
动感小麦兜3 分钟前
NAS学习
java·开发语言·eureka
小安同学iter20 分钟前
天机学堂day05
java·开发语言·spring boot·分布式·后端·spring cloud·微服务
那我掉的头发算什么20 分钟前
【javaEE】文件&IO--文件内容操作
java·java-ee·文件·文件操作
yaoxin52112328 分钟前
262. Java 集合 - Java 中 ArrayList 与 LinkedList 读取元素性能大对决
java·开发语言
大迪吃小迪33 分钟前
Vert.x 常见问题精简总结
java·websocket·web
毕设源码-钟学长1 小时前
【开题答辩全过程】以 农村困境儿童帮扶助学系统为例,包含答辩的问题和答案
java·eclipse
白露与泡影1 小时前
springboot中File默认路径
java·spring boot·后端
heartbeat..1 小时前
使用 Apache POI 实现 Excel 文件读写(导入 导出)操作的工具类
java·apache·excel·文件
Byron Loong1 小时前
【Debug】vscode 调试python,如何配置固定调试文件
ide·vscode·python
咕咕嘎嘎10241 小时前
C/C++内存对齐
java·c语言·c++