新idea的注释配置

1、代码规范

注释:设置>Editor>File and Code Templates

包注释模板:

/*

* projectName ${PROJECT_NAME}

* fileName ${NAME}.java

* packageName ${PACKAGE_NAME}

* date ${YEAR}‐${MONTH}‐${DAY} ${TIME}

*/

类注释模板:

/**

* TODO

* @author Dingjd

* @description ${DESCRIPTION}

* @className ${NAME}

* @date ${YEAR}‐${MONTH}‐${DAY} ${TIME}

*/

以上可用于类、接口、枚举

方法注释:设置>Editor>Live Templates

点击加号的Template Group


新建自定义模板

方法注释模板:

*

* TODO

* @author Dingjd

* @date  $date$ $time$ $params$ $return$

*/


点击Edit variables设置参数


param和return可自己实现

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

设置完成后,在方法上一行输入/** 然后回车,就可以自动生成注释了。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容