Idea生成类注释和方法注释模板

朱雀 2022-04-02 05:53 399阅读 0赞

点击按钮如下

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70]

先建立Template Group组 然后在组里建立live template模板  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 1]

我的如下 a 是类注释模板 和b是方法注释米板  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 2]

分别点击a和b编辑快捷键和模板代码  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 3]

还可以指定模本的应用范围

类模板：

/**
     * @Author zhanghui
     * @Description //TODO $end$
     * @Date $date$ $time$ 
     **/

方法模板：

/**
     * @description
     * @date $date$ $time$ 
     $param$
     * @return $return$
     **/

点击按钮进行变量控制：如 d a t e date date, t i m e time time 等，也可以自己定义变量  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 4]

如下大部分可以使用系统定义的  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 5]

但是param需要使用脚本

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')};return result", methodParameters())

结果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 6]

方法的代码注释需要在方法体里面敲快捷键不然param的值是null

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 7]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70]: /images/20220402/7a7c8d1d589945afae40d4a30695e97e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 1]: /images/20220402/9237bb50e434484e8a46e9aad9de29b5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 2]: /images/20220402/313024cd4c8a4668aaeca3075258f39e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 3]: /images/20220402/04ec51d9607143258e254f64a5f53790.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 4]: /images/20220402/c6fc96623f6e4991adc3e7009d070b0a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 5]: /images/20220402/283bdaba455b467795e29a8fb510b9ed.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 6]: /images/20220402/a17109bf15224921921fbae0fdcd103e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RpZGk3Njk2_size_16_color_FFFFFF_t_70 7]: /images/20220402/2be865cb4e084f35b5c9ee66d18a3803.png