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 小时前
Java深入解析篇十七之SpringCloud
java·开发语言
是未才1 小时前
从输入 URL 到页面返回:DNS、路由、TLS 与 HTTP 完整链路
java·后端·计算机网络
ttod_qzstudio2 小时前
Java 常用语法极简通关(五):类与对象——字段、方法、构造器、this 与 static
java·开发语言·python
萧瑟余晖3 小时前
Java深入解析篇十七之Spring Security
java·开发语言·spring
离陌在学C#5 小时前
C# 重载与重写:深入理解面向对象编程的核心概念
java·c#
洛阳泰山6 小时前
AI 应用层被 Python 卷成红海,为什么我偏要用 Java 造一个 RAG + 工作流引擎?
java·人工智能·后端
二十雨辰6 小时前
[Java]-Spring面试题
java·开发语言
老马历写记6 小时前
Maven POM 依赖管理总结
java·maven·system·pom·optional
古法安卓6 小时前
Android-车机 GNSS 定位数据接收问题排查
android·java·android studio
蔬菜_6 小时前
前端转全栈-day5(数组、list、set)
java·前端·数据结构·list