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(生成成功)完成后如下图:
相关推荐
z***y8621 分钟前
Java数据挖掘开发
java·开发语言·数据挖掘
鱼锦0.04 分钟前
基于spring+vue把图片文件上传至阿里云oss容器并回显
java·vue.js·spring
從南走到北9 分钟前
JAVA国际版同城跑腿源码快递代取帮买帮送同城服务源码支持Android+IOS+H5
android·java·ios·微信小程序
q***098012 分钟前
Spring Boot 2.7.x 至 2.7.18 及更旧的版本,漏洞说明
java·spring boot·后端
Molesidy22 分钟前
【VSCode】使用 VSCode + EIDE插件 的开发STM32的超详细教程
ide·vscode·stm32·编辑器·eide
q***146423 分钟前
oracle 12c查看执行过的sql及当前正在执行的sql
java·sql·oracle
洛克大航海38 分钟前
安装 Visual Studio Code 及其插件用于前端开发
ide·vscode·编辑器
好好研究1 小时前
SpringMVC框架 - 获取请求参数常用的注解
java·spring·mvc
c***93771 小时前
springboot使用logback自定义日志
java·spring boot·logback
七夜zippoe1 小时前
JVM调优实战:从GC日志分析到参数配置(Xmx, Xms, XX:+)
java·jvm·gc·jit·垃圾回收器