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(生成成功)完成后如下图:
相关推荐
HerayChen39 分钟前
HbuilderX 内存溢出报错
java·大数据·linux
程序员小白条1 小时前
0经验如何找实习?
java·开发语言·数据结构·数据库·链表
小马爱打代码1 小时前
Spring AI:搭建自定义 MCP Server:获取 QQ 信息
java·人工智能·spring
郭涤生1 小时前
QT 架构笔记
java·数据库·系统架构
daidaidaiyu1 小时前
基于LangGraph开发复杂智能体学习一则
java·ai
小小8程序员2 小时前
STL 库(C++ Standard Template Library)全面介绍
java·开发语言·c++
a努力。2 小时前
Redis Java 开发系列#2 数据结构
java·数据结构·redis
a努力。3 小时前
腾讯Java面试被问:String、StringBuffer、StringBuilder区别
java·开发语言·后端·面试·职场和发展·架构
Vic101014 小时前
解决 Spring Security 在异步线程中用户信息丢失的问题
java·前端·spring
QD_IT伟4 小时前
SpringBoot项目整合Tlog 数据链路的规范加强
java·spring boot·后端