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(生成成功)完成后如下图:
相关推荐
李贺梖梖2 分钟前
day01 Java概述、IDEA安装、Java基础语法
java
urkay-6 分钟前
Android getDrawingCache 过时废弃
android·java·开发语言·kotlin·iphone·androidx
CoderYanger12 分钟前
C.滑动窗口-求子数组个数-越短越合法——3258. 统计满足 K 约束的子字符串数量 I
java·开发语言·算法·leetcode·1024程序员节
张较瘦_13 分钟前
Spring Boot | 学习Spring Boot 3要有哪些Java基础?
java·spring boot·学习
X***C86218 分钟前
JavaWeb项目打包、部署至Tomcat并启动的全程指南(图文详解)
java·tomcat
阿宁又菜又爱玩26 分钟前
Mybatis学习
java·学习·mybatis
幽络源小助理26 分钟前
《已调试》SpringBoot景区寄存管理系统源码 - 免费JavaWeb项目下载 | 幽络源
java·开发语言·spring boot
脸大是真的好~28 分钟前
尚硅谷-索引优化以及查询优化
java
豆沙沙包?30 分钟前
2025年--Lc302-415. 字符串相加--java版
java·开发语言
天涯路s30 分钟前
qt怎么将模块注册成插件
java·服务器·前端·qt