IDEA和Eclipse修改注释模板

修改注释模板

本文主要记录两大Java ide的注释模板的自定义修改，以符合公司团队的统一规范

---

Eclipse

打开eclipse，windows->preference->Java->Code Style->Code Templates

修改文件注释选择Files，修该Java类注释选Types，修改方法注释选Methods
点击Edit,在需要的地方点击Insert Variables
下面是模板，可根据自己的需求改

所有文件头信息

/*
 * Copyright(C) 2013-2017 Baidu Inc.ALL Rights Reserved.
 *
 * FileName: ${file_name}
 * 
 * Description: xxxxx
 *
 * History:
 * 版本号    作者    日期    操作
 * 1.0    ${user} ${date}   x
 * ...
 */

class类模板

/**
 * @author ${user}
 *
 * @version 1.0
 *
 * @date ${date}${time}
 * 
 * @see JavaDoc
 */

方法模板

/**
 * 描述:
 *
 * @param 参数说明:
 * @return 返回值:
 * @exception 异常:
 * @see JavaDoc
 */

IDEA

打开idea，File -> Settings -> Editor ->File and Code Templates

在 Include中 选中 File Header,修改为如下内容(custom)

/*
 * Copyright(C) 2013-2017 BaiduInc.ALL Rights Reserved.
 *
 * FileName: ${NAME}
 * 
 * Description: xxxxx
 *
 * History:
 * 版本号    作者    日期    操作
 * 1.0    ${USER} ${DATE}   x
 * ...
 */

在 Files 中选中 Class，修改Class类的注释模板

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

/**
 * @author ${USER}
 *
 * @version 1.0
 *
 * @date ${DATE}
 * 
 * @see JavaDoc
 */
public class ${NAME} {
}

自定义注解模板

File -> Settings -> Editor ->live Templates
点击 绿色’+‘
abbr 为快捷键，desc为注解的描述信息
Templat text 为模板的内容

/**
 * 描述:
 *
 * @param 参数说明:
 * @return 返回值:
 * @exception 异常:
 * @see JavaDoc
 */

在代码中 任意地方 输入 mtd，弹出提示:

就能生成注释

上面就是两大ide 的注解模板的配置，idea系列的开发环境配置大体相同