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(生成成功)完成后如下图:
相关推荐
万邦科技Lafite18 分钟前
如何通过 item_search_img API 接口获取淘宝商品信息
java·前端·数据库
AKA__Zas23 分钟前
芝士算法(双指针篇 1.0)
java·算法·学习方法
玛卡巴卡ldf28 分钟前
【LeetCode 手撕算法】(栈)有效括号、最小栈、字符串解码、每日温度、柱状图最大矩形
java·数据结构·算法·leetcode·力扣
czlczl2002092542 分钟前
MySQL 基于 GTID 的 Binlog 主从同步机制
java·jvm·mysql
Sylvia33.1 小时前
足球数据API接入实战:从认证到实时比分推送的完整指南
java·开发语言·前端·c++·python
Chloeis Syntax1 小时前
JavaEE初阶学习日记(1)---线程和进程
java·开发语言·学习·线程·javaee
YOU OU1 小时前
SpringBoot
java·spring boot·spring
北冥有鱼1 小时前
解决DTO泛滥的问题
java·java ee
国强_dev1 小时前
如何提升canal吞吐量
java·大数据·python
时空自由民.1 小时前
C/C++ volatile关键字原理及应用介绍
java·c语言·c++