IDEA中的File and Code Templates或者是 Live Templates这里就不多说了,很实用,来这里的应该都知道。但是细节问题还是需要说说,这里先贴模板。

类注释

/**
  * @program: ${PROJECT_NAME}
  * @author ${USER}
  * @since ${DATE}
  * @description: ${description}
  **/

方法注释

模板

这里注意还有个空行


   * @Author: $user$
   * @Date: $date$$params$
   * @Description: $description$
   * @return: $returns$
   */

description变量脚本

groovyScript("def result='请在此处输入方法描述信息';return result")

params变量脚本

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

使用说明(重点

在方法体外使用快捷键时,params为null或者return 为空的?

直接打出设置的快捷键是无法在方法外获得params参数的,需要先在前面打出/**


方法注释模板中,第一行为空行,也是因为上面的特点而特地优化的。


the end~

相关资料

  1. Groovy脚本教程
  2. IDEA 配置方法注释@param时自动参数的问题
留言评论
推荐阅读
  • 最新图解并详细说明GitHub中12条许可证

    概述这12条开源协议/许可证都包含(相当于Unlicense): 免责声明:即作者不承担使用后所造成的任何后果,不提供资料的可用性...

    最新图解并详细说明GitHub中12条许可证
  • README文件中的徽标该如何使用

    自定义徽标徽标由左右两块方框所组成,左边显示标签,右边显示该标签所要表达的信息。 终端模式终端模式是真正的让用户自定义徽标,只需用户提...

    README文件中的徽标该如何使用
  • 规范书写GitHub中的README

    记住:是文档,而不是代码,定义了这是一个什么项目。 概述 编写并规范README自述文件的好处 节约你我他的时间...

    规范书写GitHub中的README