idea的学习之注释模板

IDEA的注释模板*

文件注释

使用快捷键(ctrl+alt+s)打开设置面板

Editor —> File and Code Templates -->File —>Class

/**
 * @program: ${PROJECT_NAME}
 * @description: ${DESCRIPTION}
 * @author: ${USER}
 * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 **/

方法注释

Editor—> Live Templates

点击右边的+选择第2个起个名字,然后在点击第1个出现如下界面

点击1之后在2出输入*(表示/+输入此符号)+回车(在Expand with 处可以修改)就可以添加注释,在3处添加这个注释的描述,在4处添加注释的模板,之后点击5,出现如下界面…

注释模板

*
 * description: TODO:
 * date         $date$ $time$ 
 * @author      $user$
 $params$       
 * @return      $return$
 **/

此处就可以对比着填写,只有params 处的代码有些特殊因为要自动获取方法里的参数代码如下

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

完成后的模板样式如下:

   /**
     * description: TODO:
     * date         2020/11/26 8:22
     * @author      JinFan
     * @param 		a: a
     * @param 		b: b
     * @return      int
     **/
    public int sum( int a , int b){
        return a+b;
    }

因为只需要这两个就只学习了这两个。(〃‘▽’〃)