我们在开发工具中的代码注释经常会用到一些@标签,比如常用的@author ,如下:
那么我们如果要自定义一些自己需要的注释标签模板呢,比如在使用 apidoc生成接口模板时,就需要经常写一些apidoc定义的注释标签如@apiParam {type} name desc 等,但是这些标签idea 本身是没有的,需要我们自己定义。
下面介绍如何定义idea代码注释中标签模板
File -> Settings -> Live Templates -> 点击右边 添加按钮 ‘+’ -> Template Group
点击右边 添加按钮 ‘+’ -> Live Template
Abbreviation 是模板名缩写
Template text 是模板内容
设置这个模板在哪里可以使用 ,点击下面 绿色的 Define 或 Change 选择Java 里的 Comment
设置完保持关闭设置后,来体验一下,在注释/** */ 里面输入@a 就会弹出 @apiParam的选项,选择后就会输出@apiParam模板的内容: @apiParam {type} name desc
具体如下:
/**
* @apiParam {type} name desc
*/