idea自动生成类和方法的注释模板

idea自动生成类和方法的注释模板

一、类注释的自动生成

1.进入settings=>Editor=>Code Style=>File and Code Templates,选择Class文件

 

2.编辑File Header.java文件，将注释样式添加至右边的输入框，然后Apply就行了，样式可以自己定义，这里给出我的模板。 

 注意：定义获取数据的标签格式为${},且注意大写，否则获取不到你想要的数据，创建人部分可以直接写死

/**   
 * 包名称： ${PACKAGE_NAME} 
 * 类名称：${NAME} 
 * 类描述：${TODO}
 * 创建人：@author xxx
 * 创建时间：${DATE}/${TIME}
 *     
 */ 

 二、方法注释的自动生成

1.进入settings=>Editor=>Code Style=>Live Templates,点击右上角的+号，创建一个Template Group，名字自己定义

2.选中刚刚建立的模板分组，点击右上角+建立一个模板，Abbreviation里面定义快捷键，并在Expand with选择打出的方式，以我的为例：打出*m后按下enter键就可以输出注释模板了。注释模板就写在左下角的输入框里面。下面给出我的模板样式。

注意：标签格式为$xx$,还可以点击第六部进行对标签定义表达式和默认值，如果标签格式不对点击Edit variable没有反应，最后下面会提示要你选择类型，选java就好了。

/**
 * @Title: $enclosing_method$
 * @Description: $todo$(这里用一句话描述这个方法的作用)
 * @return: $return_type$   
 * @throws
 * @author: xxx
 * @Date:  $date$/$time$ 
 */

3.对标签定义表达式，其含义可以根据英文名得出，也可以设置默认值。