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(生成成功)完成后如下图:
相关推荐
zxb@hny37 分钟前
vscode命令面板输入 CMake:build不执行提示输入
c++·ide·vscode
程柯梦想1 小时前
Maven修改默认编码格式UTF-8
java·maven
涛ing1 小时前
【5. C++ 变量作用域及其深入探讨】
java·linux·c语言·开发语言·c++·ubuntu·vim
字节全栈_mMD2 小时前
Flink Connector 写入 Iceberg 流程源码解析_confluent icebergsinkconnector
java·大数据·flink
小园子的小菜2 小时前
RocketMQ中的NameServer主要数据结构
java·中间件·rocketmq·java-rocketmq
平凡君3 小时前
缓存的今生今世
java·spring·缓存
纠结哥_Shrek3 小时前
Java 有很多常用的库
java·开发语言
爱是小小的癌4 小时前
Java-数据结构-优先级队列(堆)
java·前端·数据结构
天乐敲代码4 小时前
JAVASE入门十五脚-网络TCP,UDP,,Lambda
java
2501_903238655 小时前
自定义登录页面的Spring Security实践
java·后端·spring·个人开发