在IDEA中配置注释模板

为了统一项目代码规范,要求大家都统一Java类和方法注释,如下:

类注释格式:

/**
 * <p>描述:${DESCRIPTION}</p>
 *
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @version 1.0
 */

方法注释格式:

/**
 * TODO: 方法功能描述
 * @author ${USER}
 * @since $date$ $time$
 * @param $param$
 * @return $return$
 */

在IDEA中可以分别添加如下类注释模板和方法注释模板:

配置路径:Editor > Live Templates

第一步:新建Template Group,命名为:ccc(也可以命名为其他任意名称)
第二步:在上一步新建的Template Group中新建Live Template

新建类注释模板:
Abbreviation:ccc(也可以指定其他任意字符,就是一个快速添加注释的缩写)
Description:类注释模板
Template text:

/**
 * <p>描述:${DESCRIPTION}</p>
 * @author $USER$
 * @date $DATE$
 * @version 1.0
 */

变量值:
USER:可以为固定值,也可以使用表达式取值,如:admin(固定值),user()(表达式取值)。
DATE:date("yyyy.MM.dd HH:mm:ss")

应用范围:Java -> Declaration

在需要添加注释的类名上面输入:ccc + TAB就可以快速添加类注释。

新建方法注释模板:
Abbreviation:*(只能用星号,不能用其他字符)
Description:方法注释模板
Template text:

*
 * TODO: 方法功能描述
 * @author $USER$
 * @since $DATE$
$PARAMS$
 * @return
 */

变量值:
USER:可以为固定值,也可以使用表达式取值,如:admin(固定值),user()(表达式取值)。
DATE:date("yyyy.MM.dd HH:mm:ss")
PARAMS:

groovyScript("def params = _1; if (params == null || params.isEmpty()) return ''; def result = ''; for (i = 0; i < params.size(); i++) { result += ' * @param ' + params[i] + (i < params.size() - 1 ? '\\n' : '') }; return result", methodParameters())

应用范围:Java -> Comment

在需要添加注释的方法名上面输入:/** + TAB快速添加方法注释。


转载请注明来源,欢迎对文章中的引用来源进行考证,欢迎指出任何有错误或不够清晰的表达,在下面评论区告诉我^_^^_^