✨✨个人主页:沫洺的主页
📚📚系列专栏: 📖 JavaWeb专栏📖 JavaSE专栏 📖 Java基础专栏📖vue3专栏
📖MyBatis专栏📖Spring专栏📖SpringMVC专栏📖SpringBoot专栏
📖Docker专栏📖Reids专栏📖MQ专栏📖SpringCloud专栏
💖💖如果文章对你有所帮助请留下三连✨✨
文档注释,主要依赖于javadoc.exe,提取java源代码文件中的注解结构,生成html-api 参考文件
🍂第一种通过cmd命令窗口生成
首先创建一个Java文件,我这里是通过EditPlus编辑器写了一个Java文件,也可以直接桌面创建一个文本文件后缀名改为.java
打开EditPlus编辑器
新建一个Java文件(也可以导入)
然后写一下代码和说明
CTRL+S保存(找个位置进行保存)
保存成功
在此目录下输入cmd进入命令窗口
输入javadoc -d api A.java(将javadoc生成的文档保存在当前目录下,名为api)
回车
如果运行时出现乱码(编码GBK的不可映射字符)
输入-encoding UTF-8 -charset UTF-8
然后文件生成成功
双击index.html文件
这里就是生成的api
然后输入我们想要查看的信息(比如说项目版本和项目作者)
运行
点击A类 版本和作者就出现了
文档注释如下图
🍁第二种通过IntelliJ IDEA工具生成
打开IDEA,找到Tools>Generate JavaDoc...
选上文件位置
将生成的文件放到文件里(我这里是桌面\生成api的文件夹)
选上要查看的文档标记
输入编码格式
最后点击ok
这里就自动弹出api的html页面了