IDEA设置类注释、方法注释（macOS和windows都有效）

一、概述

IDEA不能像Eclipse一样直接导入xml设置代码模板。

严格按照文档操作，IDEA旗舰版 2020.1-2020-3（其他版本没有测试）windows和macOS都是100%可以设置成功的。

二、类注释

1.每个类头部必须加：用途：
2.每个类上方必须写明以下注释（逆向生成的不用写）

/**
* 用途: TODO
* 
* @author: ADAM
* @create: ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
* @version: 1.0
*/

快捷方式：
【Settings/Preferences】-> 【Editor】 -> 【File and Code Templates】-> 【File】-> 【Class】 覆盖、【Interface】引入

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")

/**
* 用途: TODO
* 
* @author: ADAM
* @create: ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
* @version: 1.0
*/
public class ${NAME} {
}

三、方法注释

1.每个方法前面必须加：功能：
2.接口层所有方法和类内部方法必须写注释
3.切记不要加/ 否则methodParameter方法获取不到值

*
 * 功能：TODO
 * 
$PARAMS$
 * @return: $RETURN$
 * @author: ADAM
 * @date: $DATE$ $TIME$
 */

快捷方式：添加快捷键

• 1.创建模板组
  【Settings/Preferences】-【Editor】-【Live Templates】-【+】-【Template Group】- ADAM -> 快捷键输入*

  • 方法注释快捷生成

    键	值
    Abbreviation（快捷键）	*
    Description（描述）	方法注释快捷生成
    Template Text（代码块）	详见上面
    Applicable（应用于）	Java

  • Edit variables

    将代码块中的变量映射到表达式：自动定义类名

    Name	Expression	Default value
    PARAMS		groovyScript脚本见下
    RETURN	methodReturnType()
    DATE	date()
    TIME	time()

    groovyScript:

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

  • Options

    Expand with : Enter

• 2.使用

输入/**回车