IDEA 类和方法的注释

IDEA 类和方法的注释

一、设置方法的注释

(1) 打开file->setting->Editor->LiveTemplates点击右上面那个+号，选择Template Group双击，然后弹出一个窗口，添加命名为KeyBoard点击OK完成，如下图1所示：

图1

（2） file->setting->Editor->LiveTemplates这个路径下点击一下刚才添加的KeyBoard，点击右上面那个+号，选择LiveTemplate双击，把以下代码2复制粘贴在黑框内，在Abbreviation内填写 a，在Abbreviation内填写 方法注释 快捷键：/+a+Enter，如下图2所示：

** 
 * $END$
 * 
$params$
 * @return  $returns$
 * @author  ManolinCoder
 * @date  $YEAR$-$MONTH$-$DAY$
 */

图2

（3） 点击Define/Change选择Java，如图3所示：

params

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' : '')}; return result", methodParameters())

returns

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

YEAR

date("yyyy")

MONTH

date("MM")

DAY

date("dd")

图3

(4) 点击右下角的Edit variables 按钮，然后弹出一个窗口，在Expression选择相应的参数，如下图4所示：

图4

(5) 再点击apply,点击Ok，在方法头上添加 /a+Enter ，输入 /a 再按回车键 Enter 即可创建方法注释，如下图5所示：

图5

二、创建类前-设置类的注释

（1）打开file->setting->Editor->Filr and Code Templates->Includes->File Header，如下图6所示：

图6

（2）在右边黑框内复制粘贴一下代码1：

/**
   * ${todo}
   * 
   * @author ManolinCoder
   * @date ${YEAR}-${MONTH}-${DAY}
   */ 

保存之后,当你创建类的时候就会自动生成注释。

三、创建类后-设置类的注释

1. 操作方式如同 类注释 操作： file->setting->Editor->LiveTemplates这个路径下点击一下刚才添加的KeyBoard，点击右上面那个+号，选择LiveTemplate双击，把以下代码2复制粘贴在黑框内，在Abbreviation内填写 c，在Abbreviation内填写 类注释 快捷键：/+c+Enter，如下图7所示：

操作代码：

** 
 *  
 * @author  ManolinCoder
 * @date  $YEAR$-$MONTH$-$DAY$
 */

图7

2. 再点击apply,点击Ok，在类头上添加 /c+Enter ，输入 /c 再按回车键 Enter 即可创建类注释，如下图8所示：

图8