一、方法或类注释

在一个方法或类的开头，输入/**，然后按回车,自动根据参数和返回值生成注释模板，我们在这个模板上面编写即可。

public class catTest3 {
    public static void main(String[] args) {
        List<Cat>cat=new ArrayList<>();
        Cat a=new Cat("布偶",1);
        Cat b=new Cat("大橘",2);
        Cat c=new Cat("蓝短",3);

        cat.add(a);
        cat.add(b);
        cat.add(c);
 //鼠标定位在想要加注解的方法上面，输入/**，然后回车键
    /**
     * 显示Cat信息
     * @param cat
     */
    private static void showCat(List<Cat> cat) {
        for (Cat c:cat) {
            System.out.println(c.getName()+","+c.getAge());
        }
     }
    }

二、 自行创建模板的方法(在方法上加注释)

一、File-->Settings-->Editor-->Live Templates

二、新建模板
（1）新建组：命名，如：DescDefine
（2）新建模板：命名为*
由于IDEA生成注释的默认方式是：/*+模板名+快捷键（好比若设置模板名为add快捷键用Tab，则生成方式为/*add+Tab），若是不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters()
（3）把下面的模板代码粘贴进去
@Author kane是作者的名字，换成自己的名字
*

• @Description: $description$
• @Param $params$
• @Return $return$
• @Throws $throws$
• @Author kane
• @Date $date$ $time$
  */
  （4）设置参数的获取方式：选择右侧的Edit variables按钮
  

（5）设置Options：
这里将快捷键设置为Enter回车键

（6）保存

三、测试

在待加注释的方法前面输入： /**回车

注意：

1）由于我们自己创建的模板名也是*，故此时输入/**回车后，调用的是刚自己创建的模板，而非最开始的那个默认模板）；
2）如果我们输入的模板名是其他键，比如&，则输入/*&回车键（/*+模板名+快捷键）即可。

三、类上加注释：

见文章：https://blog.csdn.net/weixin_44076342/article/details/106789384
创建类时自动生成注解的链接

idea类注释模板

在创建类的时候直接生成类注释
两种方法：

1. 按照顺序打开File–>settings–>Editor–>File and Code Templates–>Includes–>File Header
2. 按照顺序打开File–>settings–>Editor–>File and Code Templates–>Files–>Class

输入类注释代码(按照自己需求来即可）：

/**
 * @author ${USER}
 * #Description ${NAME}
 * #Date: ${DATE} ${HOUR}:${MINUTE}
 */

效果如下：

idea方法注释模板

在idea中是没有直接生成方法注释的快捷键的，我们可以通过psvm、sout等类似快捷方式生成模板

首先，依次打开File–>Settings–>Editor–>Live Templates
然后，点击右边的”+“号,选择Template Group，创建自定义的新组，如下图所示：

选择自己的组名，点击”+”号，选择Live Template，创建新的活动模板，其中Abbreviation输入自定义的快捷字（图中为add），类似于psvm、sout，使用时输入他加上Tab键即可，如下图所示：

Template text中需要填写模板代码：

/**
 * #Description $description$
 * @param $params$
 * @return $returns$
 * @author feizhen
 * #Date $date$
 */

不过最好不要这么写，因为直接使用add+tab方式是无法在方法外面获取方法参数的，只能在方法内部获取

为解决此问题，可以在/*后面输入add(自定义），之后按Tab键
此时，模板代码应改写为下图所示（因为前面已有/*了）

*
 * #Description $description$
 * @param $params$
 * @return $returns$
 * @author feizhen
 * #Date $date$
 */

之后，点击Template text下方的Define，按需求选择，一般选择java即可

只有第一次会出现Define，如果是想修改，可以右键点击模板名，选择Change context，如下图所示

最后，编辑变量，获取参数。如下图所示：

演示过程如下：

按下Tab键

可以发现，此时注释中的@param参数会被[]包起来，产生报错，对于此情况，我们可以使用脚本，不再使用idea自带的方法

脚本如下：

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

最终效果：

1.在 file > setting 中搜索 live Templates

然后点击右边的加号，点击第二个创建一个模板组，取一个名字

创建完组后再点第一个生成模板配置

出来如下界面，自定义一个快捷键，然后点击define

根据需求选择，如果是为java类和方法生成文档注释就选择java

接下来就是自定义生成的内容，将下面内容复制到Template text中

**
*@ClassName: $name$
*@Description $description$
*@Author 陈平
*@Date $date$
*@Time $time$
*/

然后点击右侧Edit Variable设置值


设置好后点ok，回到方法上一行
输入 / + 刚刚设置的快捷键 + Tab 就会生成相应的文档

实际效果如图所示