IDEA Live Templates

Live Templates

可参考：https://jetbrains.com.zh.xy2401.com/help/idea/settings-live-templates.html

方法文档注释

Template text

**
 * @description: $DESCRIPTION$
 * @version: $VERSION$
 * @date: $DATE$ $TIME$
 * @param: $PARAM$
 * @return: $RETURN$
 * @author: DengJia 18402894534@163.com
 */

Variables

Name	Expression	Default value	Skip if defined
DESCRIPTION	$cursor$
VERSION	"VERSION"	3.2.2.1
DATE	date()
TIME	time()
PARM	$PARAM$
RETURN	$RETURN$

$PARAM$
⇩
groovyScript(
    "
        if(\"${_1}\".length() == 2) {
            return '-';
        } else {
            def result = '';
            def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
            for(i = 0; i < params.size(); i++) {
                result += i == 0 
                    ? '传参说明：\\n * \\t\\t' + params[i] + ' -> ' 
                    : '\\n * \\t\\t' + params[i] + ' -> ';
            };
            return result;
        }
    ",
    methodParameters()
);
    

$RETURN$
⇩
groovyScript(
    "
        def result = \"${_1}\";
        if(result == \"void\") {
            return \"void\";
        } else {
            return \"{@link \" + result.replaceAll('[\\\\s]', '') + \"}\";
        }
    ",
    methodReturnType()
);

备注

Javadoc 需熟知注释标签

• @see: 引用类/方法。
• @author: 作者。
• @date: 日期。
• @version: 版本号。
• @throws: 异常信息。
• @param: 参数
• @return: 方法返回值。
• @since: 开源项目常用此标签用于创建日期 。
• {@value} 会使用该值，常用于常量。
• {@link} 引用类/方法。
• {@linkplain} 与 @link 功能一致。

IDEA标签

• ${USER}: 当前用户。
• ${DATE}: 当前日期。
• ${PACKAGE_NAME}: 包名。
• ${TIME}: 当前时间。
• ${YEAR}: 当前年。
• ${MONTH}: 当前月。
• ${DAY}: 当前日。
• ${HOURS}: 当前小时。
• ${MINUTE}: 当前分钟。