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(生成成功)完成后如下图:
相关推荐
懒惰蜗牛8 小时前
Day63 | Java IO之NIO三件套--选择器(下)
java·nio·选择器·selector·半包粘包·tcp缓冲区
JavaGuide8 小时前
美团2026届后端一二面(附详细参考答案)
java·后端
打工人你好8 小时前
如何设计更安全的 VIP 权限体系
java·jvm·安全
L.EscaRC8 小时前
Spring IOC核心原理与运用
java·spring·ioc
摇滚侠8 小时前
2025最新 SpringCloud 教程,Nacos-总结,笔记19
java·笔记·spring cloud
在逃热干面8 小时前
(笔记)获取终端输出保存到文件
java·笔记·spring
爱笑的眼睛118 小时前
深入理解MongoDB PyMongo API:从基础到高级实战
java·人工智能·python·ai
笃行客从不躺平8 小时前
遇到大SQL怎么处理
java·开发语言·数据库·sql
q***87609 小时前
Spring Boot 整合 Keycloak
java·spring boot·后端
Billow_lamb9 小时前
Spring Boot2.x.x全局拦截器
java·spring boot·后端