IDEA 中自定义设置类注释和方法注释(详解)

忘是亡心i 2021-09-01 13:09 616阅读 0赞

### **在网上看了很多都太乱，而且说的不清楚，操作后没有效果，这里我整理一个详细的傻瓜式的操作** ###

### **一、IDEA中设置注释模板主要分为两个部分，分别是类的注释和方法的注释。** ###

1、选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→File Header文件。

![20200724100652608.png][]

1、选择File→Settings→Editor→File and Code Templates→Files→点击+号，会创建一个文件，自定义命名，这里我命名为class了

![2020072410105751.png][]

创建好Class文件后，

**方法一、注释和类一体设置 ，（简单方便**）将下面代码复制到class右边的输入框里面点击 OK

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td> <pre><code>#if (${PACKAGE_NAME} &amp;&amp; ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
* @program: ${PROJECT_NAME}
* @author: xlk
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/
#parse("File Header.java")
public class ${NAME} {
}</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

![20200724102109205.png][]

**方法二、注释和类分开设置 ，（麻烦，繁琐**）

1）、将下面代码复制到class右边的输入框里面

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td> <pre><code>#if (${PACKAGE_NAME} &amp;&amp; ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end #parse("File Header.java") public class ${NAME} { }
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

![20200724101314719.png][]

2）、然后点击Files旁边的Includes→File Header文件。将下面的代码复制到右边输入框中

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td> <p>&nbsp;</p> <pre><code>/**
* @program: ${PROJECT_NAME}
* @author: 这里是你要写开发者姓名
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

![20200724101415216.png][]

右下角官方给提供了一些注释模板，如需要可以自定义，然后点击  OK 或者 Apply 按钮

![20200724101800205.png][]

通过idea创建类的时候就会自动添加注释了，如图所示

![20200724102718726.png][]

### **下面讲解方法的自定义注释模板** ###

1、同样选择File→Settings→Editor→Live Templates。点击右边的加号，选择第二个 Template Group，创建一个分组。

![20200724102852355.png][]

1、弹出创建组的框，这里我定义一个名称，点击 OK

![20200724103121960.png][]

2、先选中刚创建的组名，再点击右边 + 号，选择第一个 Live Template，创建一个模板。

![2020072410334164.png][]

3、其中：<abbreviation>：填模板的缩写，（也可以认为是设置的快捷键）可以使用\*\*号作为代号，方便后面调用模板。

4、Options→Expand with：填注释模板的扩展快捷键，这里使用默认的Enter。

5、Template text：填写注释模板的内容。参数名使用$\{参数名\}$的格式。**（注意：注释模板开头的/不要填写，否则会出现param为null的情况）**

注释模板的内容如下：（注意模块也可以直接复制到Template text的输入框内）

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>**&nbsp;<br> * @Description: $description$&nbsp;<br> * @Param: $params$&nbsp;<br> * @return: $return$&nbsp;<br> * @Author: xlk&nbsp;<br> * @Date: $time$ $date$&nbsp;<br> */&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

如下图所示

![20200724104825534.png][]

6、然后点击上图 5所示的 Edit variables，会读取刚刚在注释模板中的配置的参数$\{参数名\}$。在Expression的下拉框中选择方法为其赋值。如图所示：需要哪个注释模板就在后面打钩，每个参数官方都给提供参数了，点击箭头所指的下落款可以选择；

![20200724105523569.png][]

**其中 params 可以用默认的，也可以自定义；**

**默认如下图所有参数在一行展示：**

![20200724105840876.png][]

**自定义 params ，****将下面的代码复制到 Expression 下的 params里面**

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td> <pre><code>groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i &lt; params.size(); i++) {result+='* @param ' + params[i] + ((i &lt; params.size() - 1) ? '\\r\\n' : '')}; return result", methodParameters())</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

![20200724110041187.png][]

注释模板如图所示

![2020072411151086.png][]

7、点击模板页面最下方的警告define，来设置将模板应用于哪些场景，我这里选择Java及其子元素

![2020072410565761.png][]

8、选中后如下图所示，会出现一排英文，点击OK保存即可

![20200724105720980.png][]

[20200724100652608.png]: /images/20210827/722d1db1a2e64cf6a8158a352158b26c.png
[2020072410105751.png]: /images/20210827/88e6a4c0fcbb42e098d4366ca9d4c170.png
[20200724102109205.png]: /images/20210827/74586ebec62e474f978a62bb1033a8f3.png
[20200724101314719.png]: /images/20210827/78c5aa3473a5453f9937f988efc1eedb.png
[20200724101415216.png]: /images/20210827/2e46a50a8da24c00b6a0d2a83e7bcd64.png
[20200724101800205.png]: /images/20210827/99779cb5ecd64487b7e9fb0eae0829a4.png
[20200724102718726.png]: /images/20210827/f015f17c263749fb98f80f9d5902e6a7.png
[20200724102852355.png]: /images/20210827/aab32f6f82844a648af8ffb621fae2a6.png
[20200724103121960.png]: /images/20210827/682c4ae5d2074443b6d9f766a8d70eaa.png
[2020072410334164.png]: /images/20210827/775c88ebc7bf4f47a81dccd6d62ece90.png
[20200724104825534.png]: /images/20210827/03af8fe6d04d478abbf7c6f9bc237ca3.png
[20200724105523569.png]: /images/20210827/0007202a2d174de18e2de86ceef61419.png
[20200724105840876.png]: /images/20210827/dc2148f3860b4f2596066b0ca5ebae1e.png
[20200724110041187.png]: /images/20210827/89619021a701485082416c1d588d8f07.png
[2020072411151086.png]: /images/20210827/3cba7569939f4925a0ec787d7423e30d.png
[2020072410565761.png]: /images/20210827/17011c92565747bfbc1f0a0cb43f15f2.png
[20200724105720980.png]: /images/20210827/efa9eb2eb90440ad8fc4a8f082d72cc4.png