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(生成成功)完成后如下图:
相关推荐
Pniubi1 天前
怎么排查慢SQL,怎么解决?
java·数据库·sql
薛之谦_1 天前
Java 全栈知识体系:从 IDEA 高效开发到 JVM、并发与 Stream 实战
java·jvm·intellij-idea
文丑颜不良啊1 天前
LeetCode2761~2780题目解析
java·leetcode
IT枫斗者枫哥1 天前
子线程断言失败,JUnit 为什么还显示通过?
java·后端
考虑考虑2 天前
JDK27中的Set.ofLazy
java·后端·java ee
文丑颜不良啊2 天前
LeetCode2841~2860题目解析
java·leetcode
小南家的青蛙2 天前
Tomcat与Jetty深度对比
java·tomcat·jetty
乌暮2 天前
Spring AOP 与 Spring 事务:用大白话彻底理解原理与实践
java·数据库·spring boot·后端·sql·学习·spring
YDS8292 天前
Small Spring IOC篇:容器事件及其监听器
java·spring
金銀銅鐵2 天前
带您看懂字节码指令(三):一行加法里有什么
java·jvm