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(生成成功)完成后如下图:
相关推荐
yaoxin52112343 分钟前
434. Java 日期时间 API - Period 基于日期的时间段
java·开发语言·python
何极光2 小时前
IDEA集成Maven
java·maven·intellij-idea
程序员二叉2 小时前
【JUC】ThreadLocal底层原理|内存泄漏|弱引用|跨线程传递方案
java·开发语言·面试·职场和发展·juc
程序员二叉2 小时前
【JUC】线程池全套深度详解|参数|流程|拒绝策略|调优|异常处理
java·开发语言·jvm·算法·面试·juc
老马识途2.02 小时前
在AI的帮助下理解spring的启动过程
java·前端·spring
青山木2 小时前
Hot 100 --- 轮转数组
java·数据结构·算法
Qt程序员3 小时前
掌握 Linux 内核调度:从原理到实现(进程篇)
java·开发语言
code bean3 小时前
【LangChain】检索器完全指南:从向量检索到生产级 RAG 架构
java·开发语言·微服务
大白菜和MySQL3 小时前
java应用排查高线程
java·python
KobeSacre3 小时前
ReentrantLock源码
java