IDEA配置Java类注释，方法注释

一，类注释

1，创建Java类时自动添加注释设置

首先打开idea  file -> settings

如图

 

想要什么样的配置直接在设置中添加代码即可

 

常用方案：（这里的$(USER)是个人PC的当前用户名）

/**
 * @Author ${USER}
 * @Description TODO
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */

这是写死的形式

/**
 * @Author zl
 * @Description TODO
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */

别的类型

/**
 * Created by ${USER} on ${DATE} ${TIME}
 */

/**
 * Created by zl on ${DATE} ${TIME}
 */

 

根据个人喜好可随意定制（类型大全）

/** 
 * @PACKAGE_NAME: ${PACKAGE_NAME}
 * @CLASS_NAME: ${NAME}
 * @USER: ${USER}
 * @DATE: ${DATE}
 * @TIME: ${TIME}
 * @YEAR: ${YEAR}
 * @MONTH: ${MONTH}
 * @MONTH_NAME_SHORT: ${MONTH_NAME_SHORT}
 * @MONTH_NAME_FULL: ${MONTH_NAME_FULL}
 * @DAY: ${DAY}
 * @DAY_NAME_SHORT: ${DAY_NAME_SHORT}
 * @DAY_NAME_FULL: ${DAY_NAME_FULL}
 * @HOUR: ${HOUR}
 * @MINUTE: ${MINUTE}
 * @PROJECT_NAME: ${PROJECT_NAME}
**/

创建示例：

package com.zl.pojo;

/**
 * @PACKAGE_NAME: com.zl.pojo
 * @CLASS_NAME: User
 * @USER: Administrator
 * @DATE: 2020/7/29
 * @TIME: 11:31
 * @YEAR: 2020
 * @MONTH: 07
 * @MONTH_NAME_SHORT: 7月
 * @MONTH_NAME_FULL: 七月
 * @DAY: 29
 * @DAY_NAME_SHORT: 周三
 * @DAY_NAME_FULL: 星期三
 * @HOUR: 11
 * @MINUTE: 31
 * @PROJECT_NAME: 0001
 **/
public class User {
}

 

 2，对于已经创建好的类，补加注释

假如我的类都已经创建完成了，我想要后续添加注释，快速生成注释的方法

刚进设置界面直接点击 Live TEmplate 会自动生成一个User 的Group

注意：千万不用选中左侧这些，否则不会生成User

当然自己新建一个group也可以（本人亲测有效）

 

 

 

在Group下新建Live Template

 

 

 

 

设置快捷生成方式和模板

 

 

点击 Define设置，勾选Java

 

 

点击Edit variables，设置

 

 

 

 

设置好之后测试使用

 

 

 

直接回车，效果如下

 

二，方法注释

模板：切记前面不要加 / 否则methodParameter方法获取不到值

* 功能描述: <br>
 * 〈〉 $params$
 * @return: $return$
 * @author: zl
 * @date: $date$ $time$
 */

新建一个group

在Group下新建 “Live Template”

相关配置如下

 

 

 

 

 

点击Edit variables，设置

 

 

  param参数脚本：

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

 

 

还有return参数脚本，可自行根据需要配置：

groovyScript("def returnType = \"${_1}\"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '\\n * @return ' + returnType; return result;}", methodReturnType());  

 

测试：

   /** 功能描述: <br>
     * 〈〉
     * @param word:
     * @param path:
     * @return: void
     * @author: zl
     * @date: 2021/12/28 14:45
     */
    public static void export(XWPFDocument word, String path) {
    }