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

悠悠 2022-10-26 03:59 267阅读 0赞

模板是将一个事物的结构规律予以固定化、标准化的成果，它体现的是结构形式的标准化。---百度百科

很多公司或组织都有各自的代码注释规范，我们每新建类或者方法的时候如果每次重新写或者从以前的地方复制粘贴过来很麻烦，而且很容易出错。那么，设置类注释和方法注释模板就应运而生啦！其实，大家都知道，在idea中输入sout+Enter键，就会变成system.out.print()，输入psvm，就会变成public static void main （String\[\] args）\{\},其实，这也是模板的作用。

下面，教大家如何设置类注释和方法注释模板：

一，类注释模板

步骤：

File-->Settings-->Editor-->File and Code Templates-->Class-->设置类模板-->Apply-->OK

![20210201150947839.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70][]

讲解：

如上图，红的的大框里的内容为我们新建一个类的时候自动生成的代码：

默认生成包路径：

![20210201192947615.png][]

默认生成类的框架：

![20210201152513878.png][]

类注释（绿色框框）：

![20210201193519660.png][]

下面是小编设置的类注释模板，仅供参考~~~

/**
     *@Description:
     *@Author:Sarah
     *@Data:
     *@Version:
     */

大家有没有注意到@Data后面有默认值，这些其实我们可以在底下绿色框框的位置查看的

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 1][]

![20210201152835171.png][]

意味着填写了$\{DATE\}就能获取系统的时间了

二、方法注释模板

步骤：

File-->Settings-->Editor-->Live Templates-->+-->Template Group-->Create New Group-->选择刚刚新建的模板分组-->Live Templates

![20210201150947839.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 2][]

![20210201154620793.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 3][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 4][]

1、Abbreviation：模板缩写

2、Description：模板描述

3、Template text：模板text（仅供参考）

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

4、Applicable：添加模板生成的地方

注意：这个步骤很重要，一定要记得设置（我不会跟你萌说我踩过坑，设置完之后没有效果，找了好久原因）

![20210201160224483.png][]

5、编辑模板中的参数

该设置中的Name与第三条的参数一一对应

Default value中是缺省值，和类注释中的默认值同理

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())
    1

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 5][]

6、1（Abbreviation）与6组合成为生成方法注释的快捷键

如上，我们的类模板和方法模板就设置好了。

## 世界那么美好，但都是懒创造的~~~ ##

[20210201150947839.png]: /images/20221024/272b6c8c085f4f1a9e50798bbeb44fce.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70]: /images/20221024/3798f645c35c40898c6e7bb8e74be6b8.png
[20210201192947615.png]: /images/20221024/89389db6f1ce40efa017112058c418f4.png
[20210201152513878.png]: /images/20221024/224410ca9251426bbc74dca0a1be49e1.png
[20210201193519660.png]: /images/20221024/2579fba00e48491a8ef6e8b038947040.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 1]: /images/20221024/48f53bc3cf27476599b1e929824a4b40.png
[20210201152835171.png]: /images/20221024/c83958530fe74107a6831e6762324a3e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 2]: /images/20221024/75c01f5f450d49608ab2c5cc79a9ac5e.png
[20210201154620793.png]: /images/20221024/ca29c04052cb4325b543d72eeec02857.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 3]: /images/20221024/f4241f47526f469b92e55f782b6b9c3b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 4]: /images/20221024/daf6ea8ddbd54a46a78fc34557daa676.png
[20210201160224483.png]: /images/20221024/8406e2504c5a4b62a134001c14b1e1e7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlamluZ2ZhbmcxMjM_size_16_color_FFFFFF_t_70 5]: /images/20221024/5376ff40a62049e785f3ed9f94187744.png