IntelliJ IDEA设置类注释和方法注释模板

超、凢脫俗 2023-06-08 04:52 0阅读 0赞

## 1、设置类注释模板 ##

打开idea设置settings  搜索tamplate，找到File and Code Templates =>Class 编辑内容如下

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
    /**
    * @author groot
    * @date ${DATE} ${TIME} 
    * @description 
    */
    public class ${NAME} {
    }

请将groot替换为自己的名字

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70][]

这样在创建类的时候就会自动添加类注释。

## 2、设置方法注释模板 ##

###   ①先新建模板组，名字自己起。 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 2][]

### ②在新建的模板组下，创建模板，名字为\* ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 3][]

Ⅰ 、设置模板名称，建议不要换，就是 \* 号

Ⅱ、模板描述，可以没有

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 4][]

Ⅲ、模板，注意开头是没有 /\* 的，内容如下（不要看上边截图内容，内容做过修改了，以一下内容为准）。

*
     * @author groot
     * @date $date$ $time$ 
    $params$
     * @return $return$
     * Description 
     */

Ⅳ、添加模板生成的地方，点开选择java或者全部都可以。我这里选择的java和javascript

Ⅴ、设置模板快捷键，我设置为回车

Ⅵ、编辑模板中的参数。

date、time、return都可以在下拉框里进行选择相应的方法，具体如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 5][]

param，为了生成的不是例如\[param1,param2,param3\]这样的数组的形式，这里我们自己定义方法来实现，内容如下:

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_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 6][]

最后保存所有修改。

Ⅶ、用法：在方法上方输入 /\*\* + 回车 即可，这就是我为什么取名为 \* 的好处。

效果如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 7][]

搞定。^\_^

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70]: /images/20230531/f6521131ab6a4e469651933757e3a047.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 1]: /images/20230531/035e8cfdc4c84f9794ba0f3ea846795d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 2]: /images/20230531/0d00a3d32af54872898de33551853378.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 3]: /images/20230531/79625ddec96145a7880da8fc1477db0e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 4]: /images/20230531/53ea7b0569d24cbcaa7d0abaf8a3f9a6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 5]: /images/20230531/bdd392f5aebf4ce69784b591f677d023.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 6]: /images/20230531/bae8cef2ec0c451db0e451d3eaf41acd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NhcHRhaW5KYXZh_size_16_color_FFFFFF_t_70 7]: /images/20230531/41e70d0f7e6947eb9f8c4e62a5504c45.png