IDEA添加类注释和方法注释模板简单配置

￡神魔★判官ぃ 2022-09-04 01:00 345阅读 0赞

**IDEA手动添加注释模板**  
**类注释模板设置**  
1、 File–>settings–>Editor–>File and Code Templates–>Files  
2、 我们选择Class文件，右侧编辑注释模板。直接复制以下注释模板到图中红框。点击ok保存。  
3、 编辑好后新建类时即会自动生成类注释。  
4、 同理选择Interface 文件，复制模板。

/**
     *
     * 类描述:
     *
     *@author ${USER}
     *@date ${DATE} ${TIME}
     *@version 1.0
     */

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

**方法注释模板设置**  
1、 File–>Settings–>Editor–>Live Templates  
2、 新建模板组，点击右侧+号。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYXNzZA_size_16_color_FFFFFF_t_70 1]

（1） 新建组：命名为TdGroup  
![在这里插入图片描述][37010e6478464a91a5091a2638f27007.png]

（2） 新建模板：命名为\*  
名字是用来快速生成注释的，这里使用\*比较方便。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYXNzZA_size_16_color_FFFFFF_t_70 2]

（3） 设置使用模板的快捷键  
IDEA默认是TAB键使用模板，可根据喜好切换成Enter等。

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

（4） 设置模板：模板内容如下  
注意第一行，只有一个\*  
复制以下代码，到Template Text：

*
    *
    * 功能描述: 
    *
    $param$ 
    * @return $return$ 
    * @author $user$
    * @date $date$ $time$
    */

（5） 设置模板应用场景  
点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere–>Java即可

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYXNzZA_size_16_color_FFFFFF_t_70 4]  
![在这里插入图片描述][bd27562e05cd47a7a69eadc0d0812ae8.png]

（6） 设置参数的获取方法  
![在这里插入图片描述][69d23918114b44499b4066e1c7abfc4c.png]

编辑Expression列，注意第一行param 里面按以下代码填写，或复制paramScript.txt中的内容。  
其他行直接选择对应方法即可。

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

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

（7） 效果图  
在方法上面写\*\*：/\*\* + TAB\*\*

/**
    *
    * 功能描述: 
    *
    * @param  
    * @return java.util.List<com.tiandy.plugindemo.core.vo.UserVo> 
    * @author zhangsan
    * @date 2018/10/25 17:03
    */

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYXNzZA_size_16_color_FFFFFF_t_70]: /images/20220829/e697c69f17b64febbba55917a48b910f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYXNzZA_size_16_color_FFFFFF_t_70 1]: /images/20220829/09a330bd0a5c4ced9635755e1460d368.png
[37010e6478464a91a5091a2638f27007.png]: /images/20220829/8cae104994644c96aa05ee7a39ac0449.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYXNzZA_size_16_color_FFFFFF_t_70 2]: /images/20220829/f2167c98c7ab42f785a04fa4e05f0e54.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYXNzZA_size_16_color_FFFFFF_t_70 3]: /images/20220829/828376e70f63433296b6720e9b3246dc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYXNzZA_size_16_color_FFFFFF_t_70 4]: /images/20220829/7038255de90d4f5e943faa34a454f7a8.png
[bd27562e05cd47a7a69eadc0d0812ae8.png]: /images/20220829/eb75e7cce00f40cea771cc3ef3c7b417.png
[69d23918114b44499b4066e1c7abfc4c.png]: /images/20220829/927c5dd4b17d4f61a61fe1c9ef541d03.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYXNzZA_size_16_color_FFFFFF_t_70 5]: /images/20220829/1e8edcbf001847f89d9ea0f193e8d43d.png