在IDEA中设置方法自动注释（带参数和返回值）

Posted 2021-02-02 chendezhou

第一部分 设置

打开设置面板

 

 新建 在线模板

新建自动添加规则，注意 这里触发的字符 不能随便写 必须为 *

 

Template text 区域 看上去有点乱，但是是为了显示时的对齐，该区域的内容如下（空格之类的不要乱动）：

* 
    * $VAR1$
  $params$  * @return $returns$
    * @author Chendezhou
    * @date $date$ $time$
*/

　　编辑变量的内容

 

其中 VAR1 的内容如下

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

其他内容照着填写，保存，退出。

 

第二部分 应用

 

先写好方法

如

    void test1(String UserName,int UserRoll,String UserPWD)
    {
        System.out.println(UserName);
        System.out.println(UserRoll);
        System.out.println(UserPWD);
    }

在 void的 v 字符上方 键入 /**  然后按下TAB ，这里要注意，必须要按/** 触发 而不要只按一个 * ，虽然*也可以触发，但是 /**是文档注释的标准规范。

 

点击任何空白区域 

再输入相应的详细注释内容