java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > IDEA个性化设置注释模板

IDEA个性化设置注释模板详细讲解版

作者:律二萌萌哒

IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,下面这篇文章主要给大家介绍了IDEA个性化设置注释模板的相关资料,需要的朋友可以参考下

IDEA设置注释模板

1. 类注释模板

类注释模板是IDEA创建类时生成的注释

第一步、File -> Settings

第二步、Editor -> File and Code Templates -> Includes -> File Header

点apply,再点ok即可

模板参考如下:

/*
 *@title $NAME
 *@description
 *@author $USER
 *@version 1.0
 *@create $DATE $TIME
*/

2. 方法注释模板

按照 /**+Enter 来设置IDEA的方法注释

步骤

第一步、File -> Settings

第二步、选择“Editor”->“Live Templates”。

第三步、点击右侧的“+”->"Template Group…"添加组。

第四步、命名组

第五步、点击右侧的“+”->"Live Template"添加模板。

第六步、配置注释模板。

①设置一个缩写,此处设置的缩写是/**,在方法上面输入/**然后按补全键就可以按照模板生成注释了。

②对新建模板的描述

③配置的注释模板

④设置补全键

模板格式如下

**
 * @description
 * @author $user$
 $param$
 * @throws $throws$
 $return$
 * @time $date$ $time$
 */

⑤设置在哪些文件中应用此注释模板(不同类型的文件,注释符号是不一样的)

在这里插入图片描述

⑥设置模板中参数的取值

勾选每一行最后的“Skip if defined”

param和return根据自己的模板DIY了一下,如果不想用默认的,我的放在下面了。

param

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

return

groovyScript("def returnType = \"${_1}\"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '* @return ';cls = returnType.split('<');for(i = 0; i < cls.size(); i++){temp = cls[i].tokenize('.');result += temp[temp.size() - 1] + ((i < cls.size() - 1) ? '<' : '');};return result + ' ';}", methodReturnType());

第七步、最后别忘了点击“Apply”和“OK”保存设置。

3. 效果展示

总结 

到此这篇关于IDEA个性化设置注释模板的文章就介绍到这了,更多相关IDEA个性化设置注释模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文