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

　　介绍

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

将JavaDoc注释生成API文档

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

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

何使用您的代码。

3。点击eclipse的【项目】菜单,选择【生成JavaDoc】选项。

4。

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

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

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

(4)点击【下】按钮

5。

(1)勾选文档标题,然后填写文档标题。

(2)点击【下】按钮

6。

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

(2)点击【完成】按钮

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

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

9。打开医生目录,用浏览器打开指数。html

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

java自动API文档生成Yapi

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

词文档缺点

<李>

手动编写,出错性很高

<李>

文档可读性差,考验编写者的耐心

<李>

无法在线调试

<李>

及时性差

swwager文档缺点

<李>

文档可读性差

<李>

针对需要带授权令牌的请求,无法在线调试

<李>

无法导入和导出API文档

<李>

测试和开发无法在文档上沟通

Yapi解决以上所有问题,Yapi可以支持java apidoc,兼容swwager,只需要想法安装对应插件,就可以实现右键点击上传Yapi,自动生成API接口文档

@ApiOperation(“管理员创建用户“) 　　,,,@ApiImplicitParams ({ 　　,,,,,,,,,,,@ApiImplicitParam (=paramType “header",, name =,“Authentication",, dataType =,“String",, required =,真的,,value =,“用户token") 　　,,,}) 　　,,,@PostMapping(“/用户/user") 　　,,,public  CommonResult, createUser (@Validated  @RequestBody  UserAddRequest  userAddRequest), { 　　,,,,,,,Assert.isTrue (userAddRequest  !=, null,,“invalid  userAddRequest"); 　　,,,,,,,return  CommonResult.ok (userService.addUser (userAddRequest)); 　　,,,}

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