本文向您展示了如何从JavaDoc注释生成API文档。内容简洁易懂，一定会让你大放异彩。希望通过这篇文章的详细介绍，你能有所收获。
00-1010 1.打开java代码并编写javaDoc注释。只有按照Java规范编写注释，才能很好地生成API文档。javadoc注释和普通注释的区别是多了一个*(星号)。普通代码注释为/*XXX*/，而javadoc注释为/**XXX*/
2.javadoc注释应该尽可能详细地编写，这样其他人就可以知道是否没有源代码
如何使用你的代码？
3.点击eclipse的【项目】菜单，选择【生成JavaDoc】选项。
4.
(1)选择要生成JavaDoc的项目。
(2)选择什么级别的内容生成JavaDoc，默认是公共的，如果选择私有，所有内容都会生成。
(3)选择单据的生成位置，默认为项目目录，建议不要修改。
(4)点击[下一步]按钮。
5.
(1)勾选文档标题，然后填写文档标题。
(2)点击[下一步]按钮。
6.
(1)选择要使用的jdk版本(根据需要选择多个版本)
(2)点击[完成]按钮。
7.您可以看到控制台输出的生成javadoc的信息。
8.在项目下生成一个[doc]目录，其中存储了javadoc文档。
9.打开文档目录，用浏览器打开index.html。
10.您可以看到一个完整的API文档，并且生成了javadoc。
在
将JavaDoc 注释 生成API文档
的开发过程中，界面文档是前端和后端，是测试交互的基础，文档更新的及时性和准确性非常重要。
00-1010是手动编写的，非常容易出错。
文档可读性差考验着作者的耐心。
无法联机调试。
时效性差
00-1010文档可读性差。
无法对具有授权令牌的请求进行在线调试。
无法导入和导出api文档。
测试和开发不能在文档上交流。
雅皮可以解决以上所有问题。Yapi可以支持java apidoc并兼容swwager。只需要idea安装相应的插件，就可以右键上传到yapi并自动生成api接口文档。
@ApiOperation(‘管理员创建用户’)
@ ApIimplicItparams({ 0
@ apimplicitparam(param类型=’ header ‘，名称=’ authentication ‘，数据类型=’ string ‘，必需=true，值=’ user token ‘)
})
@ post mapping(‘/user/user ‘)
public commonresultusercreateresponsecretuser(@ Validated @ requestbodyuseaddrequest){ 0
Assert.isTrue(userAddRequest！=null，‘invaliduredrequest’)；
returncommonresult . ok(UserServiCe . AddUser(UserAddRequest))；
}
以上内容是如何从JavaDoc注释生成API文档。你学到什么知识或技能了吗？如果你想学习更多的技能或丰富你的知识，请关注行业信息渠道。
内容来源网络，如有侵权，联系删除，本文地址：https://www.230890.com/zhan/115598.html