超详细设置Idea类注释模板和方法注释模板

网上找了一下,没有很详细且正确介绍Idea配置注释模板的,因而结合多篇文章本身琢磨整理出以下。spa

设置类注释模板

1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header. 
这里写图片描述code

2.在右边空白处,编写本身的模板便可,注意Scheme是模板的生效范围,可选变量在description有介绍,附图中本人使用的模板(${USER}为计算机用户名,能够自行修改)。图片

/**
 * @Auther: ${USER}
 * @Date: ${DATE} ${HOUR}:${MINUTE}
 * @Description: 
 */
  • 1
  • 2
  • 3
  • 4
  • 5

3.设置完成后,建立类时自动生成注释,效果以下。 
这里写图片描述ip

设置方法注释模板

Idea没有能够直接设置方法注释模板的地方,能够借用Live Templates基本实现,步骤以下。 
1.选择File–>Settings–>Editor–>Live Templates,先选择右侧绿色加号新建一个本身的模板组,如图命名为myGroup。 
这里写图片描述it

2.选中已建好的组,选择右侧绿色加号新建模板,以下图。 
这里写图片描述io

3.填好Abbreviation(快捷输入),Description(描述)和模板内容(图中模板以下)模板

/**
 *
 * 功能描述: 
 *
 * @param: $param$
 * @return: $return$
 * @auther: $user$
 * @date: $date$ $time$
 */

  • 这里写图片描述

5.点击Edit variables编辑变量,设置以下,点击Ok–>Apply完成设置。 
这里写图片描述变量

6.输入“/**”,而后按Tab键便可生成注释,以下图。注意此方式有个缺点,须要在方法内部生成,不然@param为null。 
这里写图片描述配置

相关文章
相关标签/搜索