idea方法注释格式

idea方法注释格式

Template text中输入如下:

**
 * 功能描述:$param$ $return$
 * @author 姓名
 * @date $date$
 */

点击“Edit variables”
idea方法注释格式

param参数对应的表达式如下

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

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())
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
idea方法注释模板是编写代码时用于对方法进行注解的一种格式化规范。它的主要目的是提供给代码阅读者(包括自己和他人)关于方法功能、输入输出以及其他相关信息的快速概览。下面是一个常见的带注解的idea方法注释模板示例: ``` /** * 方法名称:methodExample * 描述:这是一个示例方法,用于展示idea方法注释模板的使用。 * 参数: * - param1: 参数1的说明,类型为xxx。 * - param2: 参数2的说明,类型为xxx。 * 返回值:返回值的说明,类型为xxx。 * 抛出异常: * - Exception1:异常1的说明。 * - Exception2:异常2的说明。 * 作者:作者的姓名 * 创建时间:方法创建的时间 * 版本:方法的版本信息 */ public returnType methodExample(param1, param2) throws Exception1, Exception2 { // 方法体 } ``` 在这个示例中,我们可以看到该注释模板的结构和内容。注释的开头是一个多行注释的开始符号(`/**`),接着是对方法名称的注释,然后是方法描述,接下来是对参数、返回值和异常的注释,最后是对作者、创建时间以及版本的注释。 借助这个模板,我们可以清晰地了解一个方法的作用、输入输出、异常等重要信息。这对于自己回顾代码或者他人阅读、维护代码都非常有帮助。同时,注释模板也促使开发者在编写方法时思考清楚这些方面的内容,提高了代码的可读性和可维护性。 当然,一个好的注释模板可能因不同的团队、项目和个人而有所不同。因此,我们可以根据实际情况调整和定制这个模板,以适应自己团队和项目的需要。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值