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(生成成功)完成后如下图:
相关推荐
弹简特1 分钟前
【JavaEE15-后端部分】SpringBoot配置文件的介绍
java·spring boot·后端
东离与糖宝2 分钟前
OpenClaw + SpringCloud 微服务集成:AI 能力全局复用
java·人工智能
丈剑走天涯4 分钟前
kubernetes Jenkins 二进制安装指南
java·kubernetes·jenkins
wuxinyan1239 分钟前
Java面试题040:一文深入了解分布式锁
java·面试·分布式锁
弹简特10 分钟前
【JavaEE16-后端部分】SpringBoot日志的介绍
java·spring boot·后端
Chan1611 分钟前
从生产到消费:Kafka 核心原理与实战指南
java·spring boot·分布式·spring·java-ee·kafka·消息队列
廋到被风吹走11 分钟前
持续学习方向:云原生深度(Kubernetes Operator、Service Mesh、Dapr)
java·开发语言·学习
HDXxiazai12 分钟前
idea JDK17 spring boot+nacos搭建 图文教程
java·spring boot·spring cloud·intellij-idea
urkay-14 分钟前
Android 当前Activity内显示的浮窗
android·java·iphone·androidx