Idea最常用的注释模板,方法级、属性级、类级、类文件级注释
作者:互联网
一、方法级注释 和 属性级注释
1、方法级注释
除 params 和 return 比较复杂,其余变量的表达式都可再图中看到,下面给出这两个变量的表达式:
(1)、params :
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')}; return result", methodParameters())
(2)、return
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';}; def p1=params[i].split(',').toList(); for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList(); result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','} } ; }; return result", methodReturnType())
唤出注释方式:按照图片上的设置的是 输入 /* 后按回车唤出方法注释。
注意:throws 的表达式获取异常,idea目前没有合适的表达式可做到,上面的方法是失效的。
2、属性注释
只需保留有变量即可,desc可自行设置为其他名字,图中设置的通过按 tab 加 f 键唤出注释。
二、类级注释 和 类文件级注释
1、类文件级注释
下面给出注释模板:
/**
* 创建人: @author xxxxxx
* 创建时间: ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}
* 项目名称: ${PROJECT_NAME}
* 文件名称: ${NAME}
* 文件描述: @Description: ${Description}
* 公司名称: xxxxxx
*
* All rights Reserved, Designed By xxxxxx
* @Copyright: 2021-${YEAR}
*
*/
2、类级注释
下面给出注释模板:
/**
* 包名称:${PACKAGE_NAME}
* 类名称:${NAME}
* 类描述:${Description}
* 创建人:@author xxxxxx
* 创建时间:${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}
*/
三、效果展示
新建一个类后会有提示输入类描述内容
希望能帮助大家,大家觉得有用的话别忘了点个赞!
标签:NAME,Idea,注释,params,result,xxxxxx,类级,def 来源: https://blog.csdn.net/qq_41394352/article/details/121314701