idea java代码注释中@标签模板创建，apidoc接口文档@标签模板创建

我们在开发工具中的代码注释经常会用到一些@标签，比如常用的@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*/

idea java代码注释中@标签模板创建，apidoc接口文档@标签模板创建相关推荐

Java代码规范、格式化和checkstyle检查配置文档
为便于规范各位开发人员代码.提高代码质量,研发中心需要启动代码评审机制.为了加快代码评审的速度,减少不必要的时间,可以加入一些代码评审的静态检查工具,另外需要为研发中心配置统一的编码模板和代码格式化模 ...
Java—使用ApiDoc接口文档
Java-使用ApiDoc接口文档前言介绍: 之前写过使用Swagger编写Api接口文档 ,介绍了Java怎么使用Swagger做项目的Api接口文档.也百度过现在生成Api接口文档的工具,看到 ...
在html文件中集成easy,easyapi 通过java注解或注释自动生成带页面的接口文档
Java-自动生成带页面可调试的接口文档介绍:一款java接口文档自动生成的插件,包含了根据接口注释或注解自动生成接口文档,可网页打开. 特点:一款无任何代码侵入的生成方式,10秒钟集成 1.支持读 ...
接口文档 HTML,附录1：接口文档参考模板
虽然提供了在线接口参数的查看,但在和客户端对接过程中,我们作为后台开发,还是需要人工提供接口文档给客户端的,这里提供一个接口文档编写的模板,以供参考,并且以我们熟悉的?service=User.Get ...
Spring Cloud Zuul中使用Swagger汇总API接口文档
有很多读者问过这样的一个问题: 虽然使用Swagger可以为Spring MVC编写的接口生成了API文档,但是在微服务化之后,这些API文档都离散在各个微服务中,是否有办法将这些接口都整合到一个文档 ...
Spring Cloud Zuul中使用Swagger汇总API接口文档 1
有很多读者问过这样的一个问题:虽然使用Swagger可以为Spring MVC编写的接口生成了API文档,但是在微服务化之后,这些API文档都离散在各个微服务中,是否有办法将这些接口都整合到一个文档中 ...
微信公众平台模板消息发送接口文档
为了保证用户不受到骚扰,在开发者出现需要主动提醒.通知用户时,才允许开发者在公众平台网站中模板消息库中选择模板,选择后获得模板ID,再根据模板ID向用户主动推送提醒.通知消息. 模板消息调用时主要需要 ...
swagger自动创建接口文档用法
现在的开发大部分都是前后端分离的模式了,后端提供接口,前端调用接口.后端提供了接口,需要对接口进行测试,之前都是使用浏览器开发者工具,或者写单元测试,再或者直接使用Postman,但是现在这些都已经o ...
快速根据注释生成接口文档网页工具——Apidoc的使用教程
环境: 操作系统 CentOS Linux release 7.6.1810 (Core) 64位服务器环境 "腾讯云"服务器 1,安装Node.js的npm工具环境: ...

idea java代码注释中@标签模板创建，apidoc接口文档@标签模板创建

idea java代码注释中@标签模板创建，apidoc接口文档@标签模板创建相关推荐

最新文章

热门文章