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(生成成功)完成后如下图:
相关推荐
Java小生不才24 分钟前
spring AI文生图
java·人工智能·spring ai
苍煜29 分钟前
ThreadPoolExecutor线程池终极全解:同步异步判定+SpringBoot生产实战
java·开发语言·spring boot
c++之路1 小时前
C++ 动态内存
java·jvm·c++
2301_800976935 小时前
数据库的基本操作后续
java·数据库·sql
SECS/GEM5 小时前
SECS/GEM如何实现越南现场自定义消息
java·服务器·数据库
lv__pf6 小时前
集合框架1
java·开发语言
蓉妹妹6 小时前
vscode的各种使用场景
ide·vscode·编辑器
Hui Baby6 小时前
java抠图
java·开发语言
许彰午6 小时前
# 手写一个迷你Tomcat——三步理解Servlet容器的核心原理
java·servlet·tomcat