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(生成成功)完成后如下图:
相关推荐
lss_dgr2 小时前
vscode中ssh环境登录copilot没有反应的问题解决
ide·vscode·copilot
dllxhcjla3 小时前
微服务全套
java
亚历克斯神3 小时前
JVM 内存管理 2026:深度解析与调优实战
java·spring·微服务
逻辑驱动的ken4 小时前
Java高频面试题:03
java·开发语言·面试·求职招聘·春招
广师大-Wzx4 小时前
一篇文章看懂MySQL数据库(下)
java·开发语言·数据结构·数据库·windows·python·mysql
野生技术架构师4 小时前
Java NIO到底是个什么东西?
java·开发语言·nio
likerhood5 小时前
简单工厂设计模式
java·ide·intellij-idea
派大星酷6 小时前
Java 调用 Kimi API 实战:实现与大模型的简单对话
java·开发语言·ai编程
猫耳球团7 小时前
IDEA与Cursor跨平台协作指南
java·ide·intellij-idea
亚历克斯神7 小时前
Java 职业发展:2026 指南
java·spring·微服务