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(生成成功)完成后如下图:
相关推荐
twj_one1 小时前
Arthas使用
java
lizz312 小时前
C++模板编程:从入门到精通
java·开发语言·c++
shoubepatien2 小时前
JAVA -- 05
java·开发语言
寰天柚子2 小时前
Java并发编程中的线程安全问题与解决方案全解析
java·开发语言·python
memgLIFE2 小时前
Springboot 分层结构
java·spring boot·spring
shoubepatien3 小时前
JAVA -- 08
java·后端·intellij-idea
kong79069283 小时前
Java新特性-(二)Java基础语法
java·新特性·java 基础语法
yangminlei3 小时前
springboot pom.xml配置文件详细解析
java·spring boot·后端
黄俊懿3 小时前
【深入理解SpringCloud微服务】Seata(AT模式)源码解析——全局事务的提交
java·后端·spring·spring cloud·微服务·架构·架构师
JAVA+C语言3 小时前
String Constant Pool
java·开发语言