[IDEA] IntelliJ IDEA 配置 注释模板

IntelliJ IDEA 配置Class Header

文件模板配置

  • Class

模板

Project Header(package)

/*
 * @ProjectName: 编程学习
 * @Copyright:   2018 HangZhou Yiyuery Dev. Ltd. All Right Reserved.
 * @address:     http://xiazhaoyang.tech
 * @date:        ${DATE} ${TIME}
 * @email:       xiazhaoyang@live.com
 * @description: 本内容仅限于编程技术学习使用,转发请注明出处.
 */

Class File Header(class)

/**
 * <p>
 *
 * </p>
 *
 * @author ${USER}
 * @version V1.0
 * @date ${DATE} ${TIME}
 * @modificationHistory=========================逻辑或功能性重大变更记录
 * @modify By: {修改人} ${DATE}
 * @modify reason: {方法名}:{原因}
 * ...
 */

模板引用

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

[IDEA] IntelliJ IDEA 配置 注释模板

配置:

	Setting > Editor > File and Code Templates

	Files : 文件脚本定义
	Includes: 文件引用模板定义

方法注释模板

[IDEA] IntelliJ IDEA 配置 注释模板

/**
 *
 $PARAMS$
 * @return $RETURN$
 * @author $USER$
 * @date $DATE$ $TIME$
 * @modify by: {修改人} $DATE$ $TIME$
 * @modify by reason:
 * @since 1.2.0
 */
@Override

[IDEA] IntelliJ IDEA 配置 注释模板

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { def site=(i>0)?' ':'';result+=site+'* @param ' + params[i] + ((i < params.size() - 1) ? '\\n':'')}; return result", methodParameters()) 1

原理:

利用内置的methodParameters函数返回的方法 @params [paramDto, userId],去掉中括号后利用groovyScript重新拼装注释模板

[IDEA] IntelliJ IDEA 配置 注释模板

REFERENCES

微信公众号

[IDEA] IntelliJ IDEA 配置 注释模板

扫码关注或搜索架构探险之道获取最新文章,不积跬步无以至千里,坚持每周一更,坚持技术分享_

上一篇:浏览器缓存机制总结


下一篇:Hive注释中文乱码解决方案