文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

将JavaDoc注释生成API文档的操作是怎样的

2023-06-21 20:32

关注

本篇文章为大家展示了将JavaDoc注释生成API文档的操作是怎样的,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。

将JavaDoc 注释 生成API文档

打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为,而javadoc的注释为

将JavaDoc注释生成API文档的操作是怎样的

javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如

何使用您的代码。

将JavaDoc注释生成API文档的操作是怎样的

点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。

将JavaDoc注释生成API文档的操作是怎样的

(1)选择您要生成JavaDoc的工程

(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。

(3)选择doc的生成位置,默认为工程目录下,建议不要修改。

(4)点击【Next】按钮

将JavaDoc注释生成API文档的操作是怎样的

(1)勾选Document Title,然后填写文档。

(2)点击【Next】按钮

将JavaDoc注释生成API文档的操作是怎样的

(1)选择使用的jdk版本(看自己的版本是多少就选择多少)

(2)点击【Finish】按钮

将JavaDoc注释生成API文档的操作是怎样的

可以看到控制台输出生成javadoc的信息。

将JavaDoc注释生成API文档的操作是怎样的

项目下生成一个【doc】的目录,里面存放着javadoc文档。

将JavaDoc注释生成API文档的操作是怎样的

打开doc目录,用浏览器打开index.html

将JavaDoc注释生成API文档的操作是怎样的

可以看到一个完整的API文档、javadoc就生成了。

将JavaDoc注释生成API文档的操作是怎样的

java自动api文档生成Yapi

开发过程中,接口文档是前后端,测试交互的依据,文档更新的及时性和准确性很重要。

word文档缺点

swwager文档缺点

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));    }

将JavaDoc注释生成API文档的操作是怎样的

将JavaDoc注释生成API文档的操作是怎样的

将JavaDoc注释生成API文档的操作是怎样的

上述内容就是将JavaDoc注释生成API文档的操作是怎样的,你们学到知识或技能了吗?如果还想学到更多技能或者丰富自己的知识储备,欢迎关注编程网行业资讯频道。

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯