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(生成成功)完成后如下图:
相关推荐
xcl09253 小时前
商超智能运营实战:数据驱动提升门店效率与体验指南
java·mfc·宠物
Flynt5 小时前
OpenJDK禁AI代码半年了,现在执行得怎么样?答案是:全靠自觉
java·开源·ai编程
古法安卓10 小时前
Android-日志系统源码解析
android·java·android studio
小夏coding11 小时前
从"一把梭"到"精妙拆解" —— 滑动窗口计时框架的设计演进
java·后端
MacroZheng12 小时前
同事问我:"Claude Code经常失忆,不怕它把项目搞炸?",我:"怕,三个Markdown文件给它装个永不丢失的外置大脑!"
java·人工智能·后端
十年Java程序媛14 小时前
深度实战:JDK21 虚拟线程 + HikariCP 生产正确配比、坑点、监控全套
java·spring boot
xiaoqiMikko14 小时前
有人在搜一个不存在的 Tomcat 版本
java·tomcat
用户31268748772017 小时前
ConcurrentHashMap 怎么保证线程安全?从分段锁到 CAS+synchronized
java
vipxieliang17 小时前
ValidX vs Apache Commons Validator:功能与性能对比
java·spring boot
SimonKing17 小时前
升级Spring Boot 4后,从 Jackson 2 到 3,到底有哪些变化
java·后端·程序员