将JavaDoc注释生成API文档的操作
作者:油纸 时间:2023-06-16 18:24:06
将JavaDoc 注释 生成API文档
1. 打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/
2. javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如
何使用您的代码。
3. 点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。
4.
(1)选择您要生成JavaDoc的工程
(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。
(3)选择doc的生成位置,默认为工程目录下,建议不要修改。
(4)点击【Next】按钮
5.
(1)勾选Document Title,然后填写文档标题。
(2)点击【Next】按钮
6.
(1)选择使用的jdk版本(看自己的版本是多少就选择多少)
(2)点击【Finish】按钮
7. 可以看到控制台输出生成javadoc的信息。
8. 项目下生成一个【doc】的目录,里面存放着javadoc文档。
9. 打开doc目录,用浏览器打开index.html
10. 可以看到一个完整的API文档、javadoc就生成了。
java自动api文档生成Yapi
开发过程中,接口文档是前后端,测试交互的依据,文档更新的及时性和准确性很重要。
word文档缺点
手动编写,出错性很高
文档可读性差,考验编写者的耐心
无法在线调试
及时性差
swwager文档缺点
文档可读性差
针对需要带授权token的请求,无法在线调试
无法导入和导出api文档
测试和开发无法在文档上沟通
Yapi解决以上所有问题,yapi可以支持java apidoc ,兼容swwager,只需要idea安装对应插件,就可以实现右键点击upload to yapi,自动生成api接口文档
@ApiOperation("管理员创建用户")
@ApiImplicitParams({
@ApiImplicitParam(paramType = "header", name = "Authentication", dataType = "String", required = true, value = "用户token")
})
@PostMapping("/users/user")
public CommonResult<UserCreateResponse> createUser(@Validated @RequestBody UserAddRequest userAddRequest) {
Assert.isTrue(userAddRequest != null, "invalid userAddRequest");
return CommonResult.ok(userService.addUser(userAddRequest));
}
Yapi使用,官方教程
来源:https://blog.csdn.net/weixin_40425415/article/details/81132733
![](/images/zang.png)
![](/images/jiucuo.png)
猜你喜欢
OpenGL Shader实现阴影遮罩效果
![](https://img.aspxhome.com/file/2023/2/137822_0s.jpg)
Android 中SwipeRefreshLayout与ViewPager滑动事件冲突解决方法
springboot使用redis对单个对象进行自动缓存更新删除的实现
![](https://img.aspxhome.com/file/2023/5/111445_0s.png)
详解C#编程获取资源文件中图片的方法
Bitmap海量数据快速查找去重代码示例
Android自定义SwipeRefreshLayout高仿微信朋友圈下拉刷新
![](https://img.aspxhome.com/file/2023/0/139400_0s.gif)
Android Retrofit的使用详解
Winform窗体圆角设计代码
![](https://img.aspxhome.com/file/2023/1/126071_0s.jpg)
Android中RecyclerView点击Item设置事件
![](https://img.aspxhome.com/file/2023/1/138821_0s.gif)
C#中TransactionScope的使用小结
![](https://img.aspxhome.com/file/2023/5/122625_0s.jpg)
Java源码解析HashMap成员变量
java发送get请求和post请求示例
Android中ListView分页加载数据功能实现
![](https://img.aspxhome.com/file/2023/2/137352_0s.png)
详解基于java的Socket聊天程序——初始设计(附demo)
![](https://img.aspxhome.com/file/2023/0/75000_0s.png)
servlet之session简介_动力节点Java学院整理
![](https://img.aspxhome.com/file/2023/2/89602_0s.jpg)
Android基于ImageView绘制的开关按钮效果示例
![](https://img.aspxhome.com/file/2023/5/126705_0s.png)
Java Swing实现JTable检测单元格数据变更事件的方法示例
![](https://img.aspxhome.com/file/2023/2/110622_0s.jpg)
C#多线程中的互斥锁Mutex
![](https://img.aspxhome.com/file/2023/5/69225_0s.png)
Java SpringSecurity+JWT实现登录认证
Java中的装箱和拆箱深入理解
![](https://img.aspxhome.com/file/2023/1/115981_0s.png)