IDEA 类注释和方法注释

---

一、类的注释

打开Idea，依次打开:File-Settings-Editor-File and Code Templates，选择Class

在文本处把模板改为:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @author 你的名字
* @since ${DATE} ${TIME}
* @description TODO
**/
public class ${NAME} {
}

同样操作，把Interface和Enum也改成同样的即可

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @author 你的名字
* @since ${DATE} ${TIME}
* @description TODO
**/
public interface ${NAME} {
}

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @author 你的名字
* @since ${DATE} ${TIME}
* @description TODO
**/
public enum ${NAME} {
    
    ;

    /** 枚举值 */
    private final String value;

    /** 枚举描述 */
    private final String desc;

    /**
     * 构造函数
     *
     * @param value 枚举值
     * @param desc  枚举描述
     */
    ${NAME}(String value, String desc) {
        this.value = value;
        this.desc = desc;
    }

    public String getValue() {
        return value;
    }

    public String getDesc() {
        return desc;
    }
}

二、方法的注释

1.File-Settings-Editor-Live templates

2.选择template Group

在Abbreviation处输入*,在Template text处填写:

**
 * TODO 
 *
$params$
 * @return $return$
 */

3.修改变量

点击Edit variables

其中params里的Expression填写:

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

需要给方法加doc注释时，/*+tab键即可生成带参数的doc注释

一些其他方便的注释:
(1) java 单行注释：

/**  */

(2) xml注释

<!--  -->

三、单行注释

如果是反斜杠 // 这种的，快捷键是ctrl + /
如果是/** 注释 */这种的，快捷键是ctrl + shift + /

关于/** 注释 */ 这种注释的话，我个人喜欢是用在定义成员变量上，但是原本打的好好的

一格式化后就成多行了

我这强迫症是不能忍！！！！ 后来发现修改位置在这里:

选中这个，这样格式化后，格式就不会再改变了。