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(生成成功)完成后如下图:
相关推荐
q***97918 分钟前
Spring Cloud GateWay搭建
java
明洞日记24 分钟前
【设计模式手册007】原型模式 - 通过复制创建对象的艺术
java·设计模式·原型模式
源码君miui520861 小时前
JAVA国际版同城服务同城信息同城任务发布平台APP源码Android + IOS
android·java·ios
鹿衔`1 小时前
解决Flink on Yarn模式多Yarn Session会话提交
java·前端·flink
静若繁花_jingjing1 小时前
SpringBoot/SpringMvc/SpringCloud
java·spring boot·spring cloud
q***04631 小时前
【springboot】Spring 官方抛弃了 Java 8!新idea如何创建java8项目
java·spring boot·spring
稚辉君.MCA_P8_Java1 小时前
Sqoop 实现的功能是什么
java·服务器·架构·kubernetes·sqoop
w***4811 小时前
【Spring】IDEA中创建Spring项目
java·spring·intellij-idea
Thexhy1 小时前
Java大模型后端开发全流程指南
java·ai·大模型
從南走到北2 小时前
JAVA同城服务场馆预约门店预约健身房瑜伽馆预约系统支持H5小程序APP源码
java·开发语言·小程序