Idea 设置类、方法注释模板(解决params和return显示问题)---不来虚的 实测有效

目录

1、使用场景

2、操作步骤

2.1、新建类模板注释添加

2.2、给类的方法生成方法注释

3、成果展现

4、参考文章


1、使用场景

        我们在开发项目的时候需要知道类的创建者,什么时间创建,这个类是什么主要作用等描述信息;以及创建方法的时候能够支持自定义的模板(方法的描述信息、创建方法的开发人员、创建日期和时间、参数名称、返回类型等)

2、操作步骤

2.1、新建类模板注释添加

         操作菜单顺序:File-->Settings-->Editor-->File and Code Templates-->Includes 

修改File Header里面的模板内容如下模板代码:

/**
 * @Description TODO
 * @Classname ${NAME}
 * @Date ${DATE} ${TIME}
 * @Created by ${USER}
 */

         在完成上面操作后如下图所示:

2.2、给类的方法生成方法注释

       网络上关于给类方法生成注释一大堆文章;但是90%的文章都是copy的没有实操。估计很多人都遇见过params和return参数无法返回,或者返回效果不佳的情况。

       操作步骤:File-->Settings-->Editor--> Live Templates

 新建自己的分组和自己的模板,这都不说了,界面如图

其中第1步选择创建自定义组,第2步选择创建模板

点击右边的”+“号,选择Template Group

第2步创建Live template

内容源码及说明:

 Abbreviation那里不要用 开头的!!! 模板中开头不要 ,从号开始 模板如下:

**
 * description: 
 * @since: 1.0.0
 * @author: 作者拼音或者英文名称 
 * @date: $date$ $time$
 $params$
 $returns$
*/

         其中第一行必须为**(两个星号) 其中参数  $params$  $returns$ 前面无需@符号

点击 Define 选择java,也可以选择everywhere

设置变量内容:

重点注意事项(以下框里面内容设置或者选定):

     

其中params和return都是设置 Default value groovyScript脚本(网上大部分不能使用)

params groovyScript脚本

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

return groovyScript脚本

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

设置 点击 应用,确定

重点:注释时需要自己打 / 符号(m),然后再打*,然后tab,这样就可以获取了!!!

3、成果展现

4、参考文章

 找到的唯一两篇靠谱的文章

IDEA自定义注释模板(主要解决params和return的问题)

IDEA 配置方法注释@param时自动参数的问题,亲自实践总结有效。

其中操作详情可以参考此文章IDEA创建类模板和方法模板(超详细)

 

  • 35
    点赞
  • 48
    收藏
    觉得还不错? 一键收藏
  • 11
    评论
### 回答1: 在IDEA编程软件中,设置方法注释模板是非常方便的。在设置之前,我们首先要了解方法注释的格式。一般情况下,方法注释包括以下内容:方法的功能描述、参数说明、返回值说明、异常抛出说明。下面是一个典型的方法注释格式: /** * 方法描述: * @param 参数名 参数说明 * @return 返回值说明 * @throws 异常型 异常说明 */ 接下来,我们可以通过以下步骤来设置方法注释模板: 1.打开IDEA编程软件,点击文件菜单栏中的Settings选项; 2.在Settings窗口中,点击Editor -> Code Style -> Java选项,打开Java代码风格设置页面; 3.在Java代码风格设置页面中,点击JavaDoc选项卡,找到Method和Constructor选项,可进行对方法和构造函数注释模板设置; 4.在设置注释模板之前,我们可以先查看一下注释模板是否已经存在,在JavaDoc选项卡中,可以看到已有的模板列表; 5.若模板不存在,我们可以点击"+"按钮,添加注释模板。在注释模板中输入常用的方法注释格式,注意要使用变量,例如${NAME}、${PARAM}等; 6.点击OK按钮保存设置,即可在写代码时使用该注释模板。 通过以上步骤,我们可以在IDEA中方便地设置方法注释模板,从而提高我们的编码效率和代码质量。 ### 回答2: Idea是一款常见的Java开发编辑器,在实际的开发过程中经常需要添加注释,以便后续代码的可读性和易维护性。在Idea中,我们可以针对不同的注释设置模板,这些模板可以帮助我们快速生成注释。 首先,在Idea中打开“Settings”(或者“Preferences”,具体视操作系统而定),在左侧导航栏中选择“Editor”,然后在右侧面板中选择“File and Code Templates”。 在“File and Code Templates”面板中,我们可以看到Idea中支持的各种代码文件型,包括Java Class、Java Interface、JUnit Test等等。针对每个型,我们可以自定义模板,在模板中指定注释生成的格式以及需要生成的内容。 具体来说,我们可以在模板中引用变量,这些变量会自动替换成真实的信息。比如,在Java Class文件中,我们需要生成名、作者、创建时间等信息,我们就可以在模板中对应添加以下代码: ``` #set($USER = "Your Name") /** * Description: * Created by $USER on ${DATE}. */ ``` 其中,$USER、${DATE}等都是Idea中预定义好的变量,分别表示当前用户和当前日期。在使用模板的时候,这些变量会自动被替换为真实的值。 除了引用变量,我们还可以使用语句控制注释生成的内容。例如,在Java Method中,我们可能需要生成参数注释,我们可以使用以下模板: ``` /** * Description: * * @param ${PARAMETER_NAME} ${OPTIONAL_DESCRIPTION} * @return ${TYPE} */ ``` 在生成注释时,Idea会自动遍历方法参数,为每一个参数生成注释。 总的来说,Idea自定义注释模板方法非常灵活,可以根据具体的需要来定制。通过合理的注释设置,可以提高代码的可维护性和可读性,提高开发效率。 ### 回答3: 在IDEA中,我们可以通过设置方法注释模板来快速生成注释,提高代码的可读性和可维护性。下面介绍具体的设置方法。 1. 打开IDEA界面,并进入“Settings”。 2. 在“Settings”中,找到“Editor”->“File and Code Tempates”选项。 3. 点击“File and Code Tempates”中的“Include”选项,并选择“Java Class”或“Java Method”等需要设置注释模板的文件型。 4. 在选择的文件型下,点击“Edit”按钮,打开文件模板编辑窗口。 5. 在编辑窗口中,找到“Comments”标签页,并选择“Method”或“File Header”。 6. 在“Method”或“File Header”下的文本框中,输入需要设置注释模板,例如: /** * ${DESCRIPTION} * @param ${PARAMETER} * @return ${RETURN} * @author ${USER} * @since ${DATE} */ 或者: /** * ${DESCRIPTION} * @author ${USER} * @version ${DATE} */ 7. 将${DESCRIPTION}、${PARAMETER}、${RETURN}、${USER}、${DATE}等占位符进行替换,并根据需要进行修改。 8. 点击“OK”按钮,保存设置。 9. 在新建方法等需要添加注释的地方,通过“Ctrl+Shift+Enter”或“Cmd+Option+T”快捷键,快速生成注释。 通过上述步骤,我们可以轻松设置IDEA中的方法注释模板,并且在编写代码过程中快速生成规范的注释,提高代码质量并减少重复工作。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值