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(生成成功)完成后如下图:
相关推荐
jiayong2332 分钟前
第 43 课:任务详情抽屉里的批量处理闭环与删除联动
java·开发语言·前端
likerhood33 分钟前
Java 访问修饰符:public、protected、private讲解
java·开发语言·javascript
Ting-yu35 分钟前
SpringCloud快速入门(5)---- 均衡负载
java·spring·spring cloud
学不思则罔1 小时前
ParallelStream并发陷阱解析
java·开发语言·windows
认真的小羽❅1 小时前
【Java并发编程】volatile关键字深度解析:从内存语义到实际应用
java·开发语言
奋斗的小乌龟1 小时前
langchain4j笔记-08
java·spring boot·笔记
leonidZhao1 小时前
Java25新特性:加密对象的PEM编码
java
计算机安禾1 小时前
【c++面向对象编程】第21篇:运算符重载基础:语法、规则与不可重载的运算符
java·前端·c++
萧曵 丶1 小时前
JUC 实际业务高频面试题浅谈
java·juc·aqs·lock