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(生成成功)完成后如下图:
相关推荐
9号达人16 分钟前
if-else 优化的折中思考:不是消灭分支,而是控制风险
java·后端·面试
不知道累,只知道类36 分钟前
Java 在AWS上使用SDK凭证获取顺序
java·aws
咖啡Beans1 小时前
SpringBoot2.7集成Swagger3.0
java·swagger
聪明的笨猪猪1 小时前
Java JVM “垃圾回收(GC)”面试清单(含超通俗生活案例与深度理解)
java·经验分享·笔记·面试
小叮当⇔2 小时前
PYcharm——获取天气
ide·python·pycharm
Moniane2 小时前
时序数据库全面重构指南
java·后端·struts
tianyuanwo2 小时前
VSCode高效使用完全指南:提升开发效率的系统化实践
ide·vscode·编辑器
whm27772 小时前
Visual Basic 值传递与地址传递
java·开发语言·数据结构
没有bug.的程序员2 小时前
云原生与分布式架构的完美融合:从理论到生产实践
java·分布式·微服务·云原生·架构
小蕾Java2 小时前
PyCharm 2025:最新使用图文教程!
ide·python·pycharm