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后端的Ai之路19 分钟前
【JDK】-JDK 21 新特性内容
java·开发语言·后端·jdk·jdk21
黎雁·泠崖2 小时前
Java常用类核心详解(七):正则表达式 Regex 从入门到实战
java·开发语言·正则表达式
sheji34163 小时前
【开题答辩全过程】以 婚纱影楼管理系统为例,包含答辩的问题和答案
java·eclipse
LuDvei3 小时前
LINUX文件操作函数
java·linux·算法
葵续浅笑3 小时前
从Spring拦截器到Filter过滤器:一次报文修改加解密的填坑经验
java·后端·spring
J2虾虾3 小时前
Spring Boot中使用@Scheduled做定时任务
java·前端·spring boot
code bean3 小时前
Visual Studio 2026 离线安装包制作指南
ide·visual studio
肉肉不想干后端4 小时前
联合订单并发退款:一次分布式锁冲突的排查与思考
java
用户4745189475104 小时前
全链路日志追踪利器:trace-spring-boot-starter 实战指南
java