IDEA给类和方法添加注释

1、类class的自动添加注释

对类class注释的自动配置需要在Preferences | Editor | File and Code Templates中设置。

1.1 打开File and Code Templates

点击Preferences -> Editor -> File and Code Templates
在Files里找到Class。
在模板框中输入如下的注释：

/**
* @program: ${PROJECT_NAME}    
*
* @description: ${description}
*
* @author: mrzhuang
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

其中，PROJECT_NAME为项目的名称，description是对类型的描述，
如图：

1.2 测试

创建一个测试类Test，并填写描述：测试类

/**
 * @program: mall
 * @description: 测试类
 * @author: mrzhuang
 * @create: 2022-04-27 22:16
 **/
public class Test {
}

2、方法的注释的设置

对于方法的上设置注解，需要在Preferences | Editor | Live Templates中设置。

2.1 打开Live Templates

Live Templates 的相关配置可以参考IDEA 中添加@author注释(live templates)

再给方法配置注释时，Template Text的内容为：

/**
* @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author: mrzhuang
* @Date: $date$ $time$ 
*/

Edit Variable 中的相关的配置如下：

2.2 测试

在方法上输入设置的模板名+tab键

    @RequestMapping("/list")
    /**
    * @Description: 列表
    * @Param: [params]
    * @return: com.zhuang.common.utils.R
    * @Author: mrzhuang
    * @Date: 2022/4/27 10:28 PM 
    */
    public R list(@RequestParam Map<String, Object> params){
        PageUtils page = brandService.queryPage(params);

        return R.ok().put("page", page);
    }
    ```