IDEA 自动生成类注释和方法注释-蒲公英云

IDEA 自动生成类注释和方法注释

末蓝、 2022-12-04 08:48 316阅读 0赞

自动生成类注释

新建类，自动生成类注释的模板配置
File->Settings->Editor->File and Code Templates->Class
【快捷键：cls + TAB】
通过快捷键，添加类注释的模板设置

/* @Description: TODO @author: scott @date: ${YEAR}年${MONTH}月${DAY}日 ${TIME} */

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmd4aWZhY2FpX2JlbGlldmU_size_16_color_FFFFFF_t_70_pic_center

/** * @Description: TODO * @author: scott * @date: $DATE$ $TIME$ */

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmd4aWZhY2FpX2JlbGlldmU_size_16_color_FFFFFF_t_70_pic_center 4

自动生成方法注释

【快捷键：/** 回车】
通过快捷键，添加方法注释的模板设置

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmd4aWZhY2FpX2JlbGlldmU_size_16_color_FFFFFF_t_70_pic_center 7

*
* @Description: TODO
* @author: scott
* @date: $DATE$ $TIME$
$PARAMS$
* @Return: $RETURN$
*/

注： $PARAMS$ 是故意无星号开头，template的Abbreviation是*，template的第一行也是*，这样输入/**回车就能输出注释。

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmd4aWZhY2FpX2JlbGlldmU_size_16_color_FFFFFF_t_70_pic_center 8

$PARAMS$ 设置

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());