日常开发当中,开发规范要求每个开发人员做到要必要的代码上加上注释。借助IDE可以快速的生成这些注释。
1.文件头部注释
每次创建新文件时会自动添加到文件头 settings—Editor—>File and Code Templates—>Includes 即是,不过这里设值类似Eclipse用 ${ }
代码语言:javascript复制/**
*
* @author ${USER}
* @data ${DATE}.
*/
2.方法注释
idea 做的相当不错的,可以根据自定义注释名称来生成自己设定的注释 settings—Editor—>Live Templates—> 点 创建 Template Group —>再点 创建 Live Temp 剩下的不用看也明白了,这里做一个模板: Abbreviation 是自定义快捷语,在代码中输入自定义名称回车就能出来。 define 选择注释生效的范围
代码语言:javascript复制/**
* method:
* description:
* @author $user$
* @data $data$ $time$
* $parameter$
* @return $return$
*/
Edit variables 中编辑对应的值
多行需要在方法内部就可以实现,方法外部参数就是出不来。好 low
3.多行需要在 $parameter$
的变量设置这面这行 groovy 脚本
写在 Default Value 里:
代码语言:javascript复制groovyScript("def result=''; def params="${_1}".replaceAll('[\\[|\\]|\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i ) {result ='@param ' params[i] ((i < params.size() - 1) ? '\n\b' : '')}; return result", methodParameters())