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(生成成功)完成后如下图:
相关推荐
挖矿大亨24 分钟前
C++中的this指针
java·开发语言·c++
sheji341630 分钟前
【开题答辩全过程】以 共享单车管理系统为例,包含答辩的问题和答案
java
北北~Simple39 分钟前
接口调不通的情况
java
Kiyra1 小时前
八股篇(1):LocalThread、CAS和AQS
java·开发语言·spring boot·后端·中间件·性能优化·rocketmq
开心比对错重要1 小时前
进程、线程、虚拟线程详解及线程个数设置
java·jvm·算法·面试
被风吹过的会不会要逝去1 小时前
Java后端开发性能优化排查思路及工具
java·性能优化
程序员阿鹏1 小时前
分布式事务管理
java·开发语言·分布式
爱学大树锯1 小时前
【594 · 字符串查找 II】
java·开发语言·算法
zhixingheyi_tian1 小时前
Yarn 之 run job
java·开发语言·前端
2501_916766541 小时前
【Java】代理模式---静态代理与动态代理
java·开发语言·代理模式