idea类注释和方法注释介绍

配置环境

电脑环境：win10
ide版本：2019.3

类注释

• 方法1：
  路径：setting->Editor->File and Code Templates->Files->Class
  
  写自己想要的注释，下面是我在用的注释方式：

/**
*@author 123
*@date ${DATE}
*@description:
*/

• 方法2：
  方法1是直接在类注释文件上添加内容，
  方法2是在类注释文件引用的文件里添加内容。
  方法二路径：setting->Editor->File and Code Templates->Includes->File Header
  
  写自己想要的注释，下面是我在用的注释方式：

/**
*@author 123
*@date ${DATE}
*@description:
*/

方法上添加注释

idea没有提供现成的类注释文件模板，需要自己在Live Templates里面以创建快捷方式的形式创建。
方法上添加注释的路径是：setting->Editor->Live Templates
1.没有组的话就新创建一个组Template Group(要是以前创建过的话也可以加到以前的组)。


2.完成组创建之后，建一个Live Template

3.然后填写模板名，注释，内容

模板名：就是自定义的快捷方式，这里我用的是m,当然也可以用其他字母，或者根据习惯用*（用*的话会和系统自带的/*注释重复，觉得没问题的也可以）
注释：随便写，我用的是方法上注释
内容：
**
*@MethodName: $discription$
*@params: $params$
*@return: $return$
*@date: $date$
*@Author: 123
*/
这里一定要注意第一行开头 一定不能有’/’,一定不能有’/’,一定不能有’/’，不然的话params和method只会是null

4.设置使用范围

在选取范围的话可以将Java项全部勾选，也可以只勾选Java里面的other项。

5.设置显示内容

我在discription中用的是方法名，这个看自己习惯吧。
params使用的是：

groovyScript(“def result=’’; def params=”${_1}".replaceAll(’[\\[|\\]|\\s]’, ‘’).split(’,’).toList(); for(i = 0; i < params.size(); i++) {result+=’[’ + params[i] +’]’+’ '}; return result", methodParameters())

return使用的是：

groovyScript(“def returnType = “${_1}”; def result = ‘’ + returnType; return result;”, methodReturnType());

这两段代码也可以根据自己的喜好来修改。

6.使用方式

输入"/m" 第一个’/‘是为了补充注释第一行缺少的’/’,'m’是就是自己设定的模板名字，当然你这里完全可以是其他东西。

总结

一步步走下来的话问题不大，就是注意下方法注释的内容要把第一行的’/'去掉，然后在使用的时候补上。