Idea 设置自动注释，并解决自动注释的@param和@return为null的问题

File------>settings----------->Editor---------------->File and Code Templates--------->class

在public class ${NAME} 上边输入你想要设置的注释， 这里是我的设置

/**
 * ${description}
 * 
 * @author zhang
 * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 */

注意：当你设置 @description:${description} 和 @version: v e r s i o n versionversion 时每次新建类都会 出现
不想每次都输入的话，可以不设置 ${description} 和 $version
设置完成点击apply.
现在每次新建类都会自动生成注释

/**
 * @author Zhang
 * @date 2020-05-07 22:45
 * @description:这是一个测试类
 * @version: 1.0.0
 */
public class Test {

}

设置自动生成方法的注释
live Templates--------->点击+ --------------->选择 Template Group 这时会弹出一个框，输入一个名字，我的叫MyGroup

Abbreviation 快捷生成注释 随便写 最好设置为* 比较简单
Description 描述，随便写
Template text 就是你要生成的模板
这是我的配置

注意
第一个/不是我漏掉了，只要写上第一个/，你的@param和@return都会为null
千万不要写上第一个/
千万不要写上第一个/
千万不要写上第一个/

**
 * 
 * 
 $params$
 * @Author  Zhang 
 * @Date   $date$ $time$
 * @Return $return$
 * @Exception   $exception$
 */

下边有一行勾选，可以选everyone 也可以只选java

点击 Edit variables

我的配置
date
date(“yyyy-MM-dd”)
time
time(“HH:mm”)
params

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

（注意 这个写在default value）
return
methodReturnType()

点击ok apply ok

最重要的一步
在你要生成注释的地方输入 / 再加上tab*
如果你之前设的Abbreviation不是 ，你要输入 / 你的Abbreviation的值 再加上tab*

/**
 * @author Zhang
 * @date 2020-05-07 22:45
 * @description:这是一个测试类
 * @version: 1.0.0
 */
public class Test {
    /**
     * create time: 2020-05-07 23:05
     * @param null
     * @return 
     */
    private int age;
    private String name;
    /**
     * create time: 2020-05-07 23:05
     * @param age
     * @param name
     * @return 
     */
    public Test(int age, String name) {
        this.age = age;
        this.name = name;
    }

    public int getAge() {
        return age;
    }
    /**
     * create time: 2020-05-07 23:05
     * @param age
     * @return void
     */
    public void setAge(int age) {
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

完成

---

原文章地址：https://blog.csdn.net/weixin_45007916/article/details/105983598