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(生成成功)完成后如下图:
相关推荐
真实的菜2 分钟前
消息队列处理模式:流式与批处理的艺术
java
盖世英雄酱5813617 分钟前
Java 内存管理技巧(新手必看集合篇)
java
码农小灰20 分钟前
Java 8 Stream API 入门到实践详解
java·java案例
步、步、为营25 分钟前
.NET 事件模式举例介绍
java·开发语言·.net
cui_hao_nan28 分钟前
设计模式——模板方法
java·设计模式
小吕学编程28 分钟前
HttpServletRequest常用方法
java·http
在未来等你29 分钟前
Java并发编程实战 Day 11:并发设计模式
java·设计模式·多线程·并发编程·threadlocal·生产者消费者·读写锁
李少兄41 分钟前
解决 idea提示`SQL dialect is not configured` 问题
java·sql·intellij-idea
BreezeDove1 小时前
IDEA安装&迁移IDEA配置数据位置
java·ide·intellij-idea
太阳之神aboluo1 小时前
压测软件-Jmeter
java·运维·jmeter