idea配置【方法注释模版】

手写方法注释难免是一件繁琐的事情,idea的配置模版很好的解决了这个问题。

1.创建方法注释模版

进入settings->Editer->Live Templates

创建方法注释模版

Abbreviation(模版名称): m

因为IDEA生成注释的默认方式是:/*+模板名+快捷键(这里模板名我设置为m,快捷键用Enter,则生成方式为:

/*m 再按下enter键即可。这个很重要,若不以这种方式生成,很可能无法读取到方法参数。

Template text注释中的内容(有自己的需求也可以相应的修改):

* 
 * 
 * @author xiangyu.zeng
 * @since $date$ $time$ $param$ $return$
 */

配置Template中的参数:

配置Template中的参数

param Expression:

groovyScript("
if(\"${_1}\".length() == 2) {
    return '';
} else {
    def result=''; 
    def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
    for(i = 0; i < params.size(); i++) {
        result+='\\n' + ' * @param ' + params[i]
    };
    return result;
}
", methodParameters());

returnType Expression:

groovyScript(" 
def returnType = \"${_1}\";  
def result = '\\n * @return ' + returnType; 
if(returnType == \"void\") { 
return ''; 
}; 
return result; 
", methodReturnType());

以上两个脚本都是基于idea自带的两个函数(methodParameters(),methodReturnType())做的封装,有自己的需求也可以相应的修改

最后可以指定生效的文件(在选中类型的文件中可以用此快捷模版):

指定生效的文件

参考:

1.Intellij IDEA设置默认文档注释 - 知乎 (zhihu.com)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容