博主
258
258
258
258
专辑

第三节 IDEA的注释模板

亮子 2021-06-30 07:03:55 5149 0 0 0

idea作为越来越多程序员使用的开发工具,平时的代码注释也非常的关键,下面介绍一下类上注释和方法上注释,方便大家的开发配置,同时也为自己以后配置留一份记录

1、新建类的时候自动添加类注释

(1)按照上图的提示,找到位置1的File and Code Templates

(2)选择右侧的Files选项卡,选择位置2的Class(如果需要设置接口和枚举的注释模版,只需要选择Interface和Enum,按照步骤3配置一下就ok了)

(3)在最右侧的输入栏中,输入位置3框住的一段注释代码,然后点击保存即可

模版配置示例如下:

图片alt

/**
 * @description: TODO
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @version 1.0
 */

2、自定义模版配置(类,方法)

图片alt

(1)按照上图的提示,找到位置1的Live Templates

(2)找到位置2,选择下拉框中的Enter选项

(3)到位置3点击“+”号,首先选择Template Group,新建一个自己的分组

(4)鼠标选中新建的分组,如位置4的ybyGroup,然后在点击位置3的“+”号,选择Live Template

(5)给模版添加快捷提示的字符,描述,和模版,比如我这里新增了两个,方法的注释*,类注释**

(6)在位置5处的Template text里面贴上模版内容

(7)在位置6选择应用的范围,一般选择EveryWhere里面的Java就可以了

(8)在位置7配置Template Text里面用$修饰的属性,具体配置截图如下:

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

图片alt

  • 类注释模板
**
 * @description TODO
 * @author $user$
 * @date $date$ $time$
 * @version 1.0
 */
  • 方法注释模板
**
 * @description $description$
 * @params $params$
 * @return $returns$
 * @author $user$
 * @date $date$ $time$
 */

图片alt