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(生成成功)完成后如下图:
相关推荐
敖正炀16 分钟前
PriorityBlockingQueue 详解
java
shark222222221 分钟前
Spring 的三种注入方式?
java·数据库·spring
陈煜的博客35 分钟前
idea 项目只编译不打包,跳过测试,快速开发
java·ide·intellij-idea
JAVA学习通38 分钟前
LangChain4j 与 Spring AI 的技术选型深度对比:2026 年 Java AI 工程化实践指南
java·人工智能·spring
.柒宇.1 小时前
Java八股之反射
java·开发语言
敖正炀1 小时前
LinkedTransferQueue 详解
java
环流_1 小时前
多线程1(面试题--常见的线程创建方式)
java·开发语言·面试
敖正炀1 小时前
ArrayBlockingQueue深度解析
java
敖正炀1 小时前
LinkedBlockingQueue详解
java
敖正炀1 小时前
SynchronousQueue 详解
java