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(生成成功)完成后如下图:
相关推荐
江上月51315 小时前
JMeter中级指南:从数据提取到断言校验全流程掌握
java·前端·数据库
晨旭缘15 小时前
零基础后端入门:JDK21 + PostgreSQL+Java项目
java·数据库·postgresql
BullSmall15 小时前
SpringBoot 项目日志规范(企业级标准 + 最佳实践)
java·spring boot·spring
better_liang15 小时前
每日Java面试场景题知识点之-线程池
java·线程池·并发编程·juc·企业级开发
一直都在57215 小时前
SpringBoot:自动配置原理
java·spring boot·spring
ss27315 小时前
ruoyi 新增每页分页条数
java·数据库·mybatis
benpaodeDD15 小时前
黑马SpringBoot2自动配置原理
java·spring boot·后端
编程大师哥15 小时前
Java web
java·开发语言·前端
电商API_1800790524715 小时前
大麦网API实战指南:关键字搜索与详情数据获取全解析
java·大数据·前端·人工智能·spring·网络爬虫
dasi022715 小时前
Java 趣闻
java