idea java修改类 方法注释模块，快速生成apidoc常用注释接口文档模板

若我们使用apidoc注释快速生成接口文档的话，每个方法需要写很多注释，如果每次都收到一个个写的话，有点浪费时间，这时我们可以用自定义模板来解决，如下注释内容是我自定义模板后一键生成的：

   /** 
   * @api {POST} path 接口描述
   * @apiDescription 接口描述
   * @apiGroup AccountController 
   * @apiHeader {String} key=desc
   * @apiParam {type} name desc
   *
   * @apiParamExample {json} 请求示例:
   * {
   *   
   * }
   * @apiSuccessExample {json} 成功响应:
   * HTTP/1.1 200 OK
   * {
   *   "code":"0",
   *    "desc":"success",
   *    "data":{
   *       
   *     }
   * }
   * @apiVersion 1.0.0
   */ 
    public String t(){
        return "";
    }

下面介绍具体实现过程：

java类的方法 注释模板创建

1 File -> Settings -> Live Templates -> 点击右上角添加符号 ’ + ’

创建了一个Template Group后，再点 ‘+’ 添加一个Live Template


Live Template 设置 几个重要的地方

• Abbreviation 模板名缩写 我给模板名缩写命名 a ，在模板可以使用的地方(下面 Define 定义这个模板在哪里可以使用) 写a 就会弹出模板选项，还可以通过快捷键一件生成模板，上面默认的模板快捷键 Tab + a 一键生成模板
• Template text 编辑模板，里面可以使用一些idea提供的变量，格式是$$
  变量的值设置在 Edit variables
• Define或Change 在下面可以看到有个 Define或Change 绿色按钮，定义这个模板可以在那里使用

我的模板内容是,可做参考

/** 
* @api {POST} path 接口描述
* @apiDescription 接口描述
* @apiGroup $className$ 
* @apiHeader {String} name=desc
* @apiParam {type} name desc
*
* @apiParamExample {json} 请求示例:
* {
*   
* }
* @apiSuccessExample {json} 成功响应:
* HTTP/1.1 200 OK
* {
*   "code":"0",
*   "desc":"success",
*   "data":{
*       
*   }
* }
* @apiVersion 1.0.0
*/

定义在哪里可以使用这个模板 点击下面绿色的的 Define 或 Change
选择 declaration ，如下：

设置完后保存一下 点击 Apply 或 Ok 保存一下

在模板里面有定义了一个方法名的变量 $className$
需要在Edit variables 里面设置这个变量值Expression为 className()

到此idea java类的方法上面的注释模板定义完了，现在去体验一下

在一个java类的方法上面输入一个 a ,就会看到有一个 apidoc注释模板选项

选择这个模板后，就会生成模板内容，如下

    /** 
    * @api {POST} path 接口描述
    * @apiDescription 接口描述
    * @apiGroup  AccountController
    * @apiHeader {String} name=desc
    * @apiParam {type} name desc
    *
    * @apiParamExample {json} 请求示例:
    * {
    *   
    * }
    * @apiSuccessExample {json} 成功响应:
    * HTTP/1.1 200 OK
    * {
    *   "code":"0",
    *   "desc":"success",
    *   "data":{
    *       
    *   }
    * }
    * @apiVersion 1.0.0
    */
    public String t(){
        return "";
    }

java类 注释模板创建

File -> Settings -> File and Code Templates -> Class

在 public class ${NAME} 上面可以插入自己想要的注释模板内容，在一个类创建时 会自动生成
我的简单模板(按需修改)

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @author: 
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/
public class ${NAME} {
}

设置完后保存关闭设置。

下面实际体验下
新建一个测试类 Test， 就可以看到创建的类上面带有模板注释内容

/**
 * @author:
 * @create: 2019-08-31 16:36
 **/
public class Test {
}