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(生成成功)完成后如下图:
相关推荐
阿波罗尼亚31 分钟前
Tcp SSE Utils
android·java·tcp/ip
susu108301891135 分钟前
springboot3.5.8整合minio8.5.9
java·springboot
不知道累,只知道类1 小时前
深入理解 Java 虚拟线程 (Project Loom)
java·开发语言
myzshare1 小时前
实战分享:我是如何用SSM框架开发出一个完整项目的
java·mysql·spring cloud·微信小程序
Chan161 小时前
【 Java八股文面试 | JavaSE篇 】
java·jvm·spring boot·面试·java-ee·八股
wen__xvn2 小时前
代码随想录算法训练营DAY10第五章 栈与队列part01
java·前端·算法
独自破碎E2 小时前
解释一下NIO、BIO、AIO
java·开发语言·nio
国强_dev2 小时前
在 Java 开发及其生态圈中“声东击西”的误导性错误
java·开发语言
FG.2 小时前
LangChain4j
java·spring boot·langchain4j
linweidong2 小时前
C++thread pool(线程池)设计应关注哪些扩展性问题?
java·数据库·c++