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(生成成功)完成后如下图:
相关推荐
李景琰17 小时前
Java 25+AI+物联网+区块链融合平台:架构设计与企业级实现
java·人工智能·物联网·区块链
追梦者12317 小时前
springboot处理全局返回日期格式,全局处理停用的数据(不返回)
java
拾光Ծ17 小时前
“异常”处理机制 与 C++11中超实用的 “智能指针”
java·开发语言·c++·安全
后端小张20 小时前
【JAVA进阶】Spring Boot 核心知识点之自动配置:原理与实战
java·开发语言·spring boot·后端·spring·spring cloud·自动配置
tg-zm8899961 天前
2025返利商城源码/挂机自动收益可二开多语言/自定义返利比例/三级分销理财商城
java·mysql·php·laravel·1024程序员节
X***C8621 天前
SpringBoot:几种常用的接口日期格式化方法
java·spring boot·后端
前端达人1 天前
你的App消息推送为什么石沉大海?看Service Worker源码我终于懂了
java·开发语言
小光学长1 天前
基于ssm的宠物交易系统的设计与实现850mb48h(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面。
java·前端·数据库
编程大师哥1 天前
vxe-table 透视表分组汇总及排序基础配置
java
8***84821 天前
spring security 超详细使用教程(接入springboot、前后端分离)
java·spring boot·spring