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

将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使用，官方教程

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

最新评论