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(生成成功)完成后如下图:
相关推荐
小羊没烦恼!19 小时前
微服务化的基石——持续集成
java·大数据·word·powerpoint·.net
俊昭喜喜里19 小时前
java中的继承和多态的区别
java
小羊没烦恼!19 小时前
初探性能优化——2个月到4小时的性能提升
java·开发语言·windows·算法·c#
譕痕19 小时前
JSONObject与JSONArray封装数据格式区别
java·json
胡写代码19 小时前
别再前后端各写一套表单校验了
java·后端
小鱼能吃糖19 小时前
缺陷修复总览 · mall电商项目:5类缺陷,1个病根,4个业务域
java·电商
此时不提桶,更待何时20 小时前
01-06-A-JVM排查实战详解
java·jvm
vipxieliang20 小时前
ValidX 在 DDD 领域驱动设计中的实践
java·spring boot
ba_pi21 小时前
mysql 查询所有表名并授权
java
ProcessOn官方账号21 小时前
java函数式编程--入门基础
java·编程·函数式编程