idea 自定义注释

2023-10-20 12:31:59 浏览数 (1)

日常开发当中,开发规范要求每个开发人员做到要必要的代码上加上注释。借助IDE可以快速的生成这些注释。

1.文件头部注释

次创建新文件时会自动添加到文件头 Perferences---Editor--->File and Code Templates--->Includes 即是,不过这里设值类似Eclipse用 ${ }

代码语言:javascript复制
/**
 *
 * @author ${USER}
 * @since ${DATE}.
 */

看效果

2.方法注释

  1. 创建 Template Group
  2. 创建 Live Template
创建 Template Group

idea 做的相当不错的,可以根据自定义注释名称来生成自己设定的注释 Perferences---Editor--->Live Templates 点 创建 Template Group 输入自己的 Template

创建 Live Template

再点 创建 Live Temp 剩下的不用看也明白了,这里做一个模板: Abb reviation 是自定义快捷语,在代码中输入自定义名称回车就能出来。 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())

0 人点赞