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(生成成功)完成后如下图:
相关推荐
Renhao-Wan19 分钟前
Java 算法实践(四):链表核心题型
java·数据结构·算法·链表
_codemonster1 小时前
JavaWeb开发系列(六)JSP基础
java·开发语言
万邦科技Lafite2 小时前
淘宝店铺所有商品API接口实战指南
java·数据库·mysql
jjjxxxhhh1232 小时前
【加密】-AES与对称加密
java·服务器·网络
临水逸2 小时前
飞牛fnos 2025 漏洞Java跨域URL浏览器
java·开发语言·安全·web安全
yaoxin5211232 小时前
324. Java Stream API - 实现 Collector 接口:自定义你的流式收集器
java·windows·python
H Corey2 小时前
数据结构与算法:高效编程的核心
java·开发语言·数据结构·算法
米羊1212 小时前
Struts 2 漏洞(上)
java·后端·struts
galaxyffang3 小时前
Java堆内存诊断:从工具使用到实战分析
java·jvm
HAPPY酷4 小时前
C++ 成员指针(Pointer to Member)完全指南
java·c++·算法