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(生成成功)完成后如下图:
相关推荐
凯瑟琳.奥古斯特8 小时前
信号分类与特性解析
java·开发语言·职场和发展
JAVA面经实录9178 小时前
JVM 性能监控 + 全链路分析实战 + 性能优化(完整版)
java·jvm
号码认证服务8 小时前
小米、OPPO、VIVO手机支持号码认证显示公司名吗?
java·服务器·网络·经验分享·智能手机·云计算·php
ChoSeitaku8 小时前
06_可变参数_递归_类和对象_封装
java·数据结构·算法
Full Stack Developme8 小时前
Spring Context 解析
java·spring·rpc
爱棋笑谦8 小时前
热部署简述
java
敲代码的瓦龙8 小时前
Android?广播!!!
android·java·开发语言·android-studio
磊 子8 小时前
1.2内存的存储金字塔
java·开发语言·spring·操作系统
逆境不可逃9 小时前
Hello-Agents 第二部分-第四章总结:智能体经典范式构建-包含习题解析和Java版
java·开发语言·javascript·人工智能·分布式·agent
ChoSeitaku9 小时前
08_抽象_接口_final关键字_多态
java·开发语言