Intellij IDEA配置注释模板

Intellij IDEA配置注释模板，本博客中使用的是Intellij IDEA版本为2018.2.5。

1.Class注释

1.1操作步骤

IEDA菜单->File->Settings->Editor->File and Code Templates->File->Class，然后输入注释模板，如下如所示：

1.2注释模板

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @ClassName : ${NAME}
* @Description : ${description}
* @Author : ZYF
* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version : 1.0.0
*/
public class ${NAME} {
}

1.3注释效果

package com.mcsas.gim;

/**
 * @ClassName : zyfClassTest
 * @Description : Class注释模板效果
 * @Author : ZYF
 * @Date: 2020-07-25 12:57
 * @Version : 1.0.0
 */
public class zyfClassTest {
}

2.Interface注释

2.1操作步骤

IEDA菜单->File->Settings->Editor->File and Code Templates->File->Interface，然后输入注释模板，如下如所示：

2.2注释模板

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @ClassName : ${NAME}
* @Description : ${description}
* @Author : ZYF
* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version : 1.0.0
*/
public interface ${NAME} {
}

2.3注释效果

package com.mcsas.gim;

/**
 * @ClassName : zyfInterfaceTest
 * @Description : Interface注释模板效果
 * @Author : ZYF
 * @Date: 2020-07-25 13:51
 * @Version : 1.0.0
 */
public interface zyfInterfaceTest {
}

3.Enum注释

3.1操作步骤

IEDA菜单->File->Settings->Editor->File and Code Templates->File->Enum，然后输入注释模板，如下如所示：

3.2注释模板

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @ClassName : ${NAME}
* @Description : ${description}
* @Author : ZYF
* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version : 1.0.0
*/
public enum ${NAME} {
}

3.3注释效果

package com.mcsas.gim;

/**
 * @ClassName : zyfEnumTest
 * @Description : Enum注释效果
 * @Author : ZYF
 * @Date: 2020-07-25 13:55
 * @Version : 1.0.0
 */
public enum zyfEnumTest {
}

4.方法注释

4.1操作步骤

IEDA菜单->File->Settings->Editor->Live Templates，然后输入注释模板，如下如所示：

4.2注释模板

/*
 * @description $description$
$params$
 * @return $return$
 */

Template Variables中的return中的“Expression”的注释如下：methodReturnType()。
Template Variables中的params中的“Default value”的注释如下：

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

4.3注释效果

int Add(int nA,double dB)
    {
    /*
     * @description
     * @param nA
     * @param dB
     * @return int
     */
        return 10;
    }