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(生成成功)完成后如下图:
相关推荐
栈外7 分钟前
我是IDEA重度用户,试了4款AI编程插件:有一款有并发Bug,有一款越用越香
java·后端
架构师沉默16 分钟前
为什么说 Go 做游戏服务器就有人皱眉?
java·后端·架构
a56299161918 分钟前
【springboot】Spring 官方抛弃了 Java 8!新idea如何创建java8项目
java·spring boot·spring
秃了也弱了。27 分钟前
ElasticSearch:优化案例实战解析(持续更新)
android·java·elasticsearch
一叶落4381 小时前
LeetCode 54. 螺旋矩阵(C语言详解)——模拟 + 四边界收缩
java·c语言·数据结构·算法·leetcode·矩阵
最初的↘那颗心1 小时前
Prompt 工程实战:五要素框架与 Spring AI 模板化落地
java·大模型·prompt工程·spring ai·ai应用开发
东离与糖宝2 小时前
Java 21 虚拟线程与 AI 推理结合的最新实践
java·人工智能
菜鸟小九3 小时前
hot100(71-80)
java·数据结构·算法
大傻^3 小时前
LangChain4j 1.4.0 快速入门:JDK 11+ 基线迁移与首个 AI Service 构建
java·开发语言·人工智能