Idea注释模板——让你的代码看起来更完美

类注释模板

1.打开Idea,File -> Setting -> Editor–>File and Code Templates,选中Class,在模板中添加以下内容:

/**
 * @author jitwxs
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */

如图
在这里插入图片描述
2. 接口也可以给自己需要添加,如需添加,选中interface,填写上述内容即可。

方法注释模板

1.File -> Setting -> Editor–>Live Templates,点击Template Group
在这里插入图片描述
2.填写你自定义组的名称,这里我写的是MyDefine
在这里插入图片描述
3.选中创建的MyDefine组,点击右侧+,选中Live Template
在这里插入图片描述
4.此时会创建一个新的模板,需要修改该模板的 Abbreviation、Description 和 Template text。需要特别注意的是,Abbreviation 必须为 *,最后检查下 Expand with 的值是否为 Enter 键。

*
 * 
 * @author jitwxs
 * @date $date$ $time$$param$ $return$
 */

在这里插入图片描述
注意:内容不要弄错,尤其是模板内容(开头没有“/”)

5.添加应用语言
在这里插入图片描述
6.设置变量参数
在这里插入图片描述
其中date和time使用idea内置的函数,而return和param使用以下内容

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

Skip if defined 属性,它的意思是如果在生成注释时候如果这一项被定义了,那么鼠标光标就会直接跳过它。可以根据需要选择。
大功告成!请你善良的小手支持下哦!你的支持就是我不懈的动力!

猜你喜欢

转载自blog.csdn.net/weixin_47088026/article/details/117030121