idea自定义注释格式

原创已于 2022-07-06 16:41:48 修改 · 1.2k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#intellij-idea #java #ide

于 2022-07-06 14:36:13 首次发布

Java 专栏收录该内容

1 篇文章

订阅专栏

博客介绍了在IntelliJ IDEA中的设置操作。包括在Settings—Editor—File and Code Templates的Includes中复制代码并点击Apply按钮，还介绍了在Settings—Editor—Live Templates添加Template Group和Live Template以设置方法注释，以及编辑模板变量的相关内容。

Settings—Editor—File and Code Templates，选择Includes，在右侧空白处复制下面代码：

/**
 * Created with CIB Co.
 * @since 1.0
 * @author ${USER}
 * @createTime ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 * @update: [序号][日期YYYY-MM-DD] [更改人姓名][变更描述] 
 */

然后点击右下角 Apply 按钮；
在这里插入图片描述

Settings—Editor—Live Templates，添加一个Template Group，然后在这个Template Group下面添加一个Live Template，输入 * ，方法注释

* $description$
 * @since 1.0     
 * @author $user$ $param$
 * @createTime $date$ $TIME$ $return$ $throws$
 * @update: [序号][日期YYYY-MM-DD] [更改人姓名][变更描述]  
 */

在这里插入图片描述 Edit Template Variables里面的内容：
description：

groovyScript("def result=''; def data=\"${_1}\";  return data=='null' ? '\\r\\n' + ' * Created with CIB Co.' + '\\r\\n' + ' * @description'  :  '\\r\\n' + ' * @description' ;", methodParameters())

usr：

user()

param：

groovyScript("def result=''; def stop=false;def data=\"${_1}\"; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();if(data=='null'){return '';}; if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i=0; i < params.size(); i++) {result +=  '\\r\\n' + ' * @param ' + params[i]; }; }; return result;", methodParameters())

date：

date()

TIME：

time()

return：

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return ' + data; }; return result;", methodReturnType())

throws：

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @throws ' + data; }; return result;", expressionType(Expression))