快速生成类注释 方法注释 接口文档(一键生成)

规则

注意点: 良好的java doc 注释能生成更好的文档

1:插件如何生成属性备注 ,通过获得字段备注中的注释

/** 
* 年龄
*/
private Integer age;

2:插件如何生成接口名称,通过接口上的注释,或者引用上的 注释

   /**
   * 通过ID查询
   * @param id ID主键
   * @return SysDept 部门信息
   */
    @GetMapping("/{id}")
    public R<SysDept> getById(@PathVariable Integer id) {
        return R.ok();
    }

3:Controller

/**
 *@description 描述
 *@menu 测试主页面(在yapi上面生成菜单)
 */   
@RestController
public class UserController {
​
}

4:推荐生成注释插件(默认配置)

查看翻译不是太好,注意修改,只是生成规则

https://gitee.com/starcwang/easy_javadoc

idea商城中可以搜索easy_javadoc

5:idea配置模版

1.类上可以不用配置,但是Controller记得加@menu

方法上

/**
* TODO 添加的注释吧。
* @Param: $param$
* @Return: $return$
* @Author: 自己的花名
* @Date: $data$ $time$
*/

image-20200916155628348

image-20200916155559277

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值