IDEA配置Java类方法注释模板

怼烎@ 2023-10-01 21:53 45阅读 0赞

### 1.类注释模板 ###

File -> Settings -> Editor -> File and Code Templates -> Files  
选择Class , Interface ，Enum 等等，我们都可以看到，在右侧区域中，在public class 上面，都有一行 \#parse(“File Header.java”)

![img][]

这句代码是引入了File Header.java文件，作为我们创建的Class Interface ,Enum 等文件的注释，那么这个类在哪呢，我们可以看到，在 Files 右侧，有一个 Includes 选项，在这里，我们可以定义各种的模板，在需要的地方去引入这个模板，这里已经在类文件中引入了File Header.java 模板，那我们就更改这个模板成为我们想设置成的样子

![image-20220512152855134][]

自定义注释模板

/**
     * @className: ${NAME}
     * @author: Kevin
     * @date:  ${DATE}
     **/

新建接口文件自动生成注释，效果如下

/**
     * @className: CrowdService
     * @author: Kvein
     * @date: 2022年05月12日 15:33:00
     **/
    public interface CrowdService {
        
    }

#### 注释模板不完全变量参考表 ####

<table> 
 <thead> 
  <tr> 
   <th>预定义变量</th> 
   <th>描述信息</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>${NAME}</td> 
   <td>the name of the current file</td> 
  </tr> 
  <tr> 
   <td>${PACKAGE_NAME}</td> 
   <td>name of the package in which the new file is created</td> 
  </tr> 
  <tr> 
   <td>${USER}</td> 
   <td>current user system login name</td> 
  </tr> 
  <tr> 
   <td>${DATE}</td> 
   <td>current system date</td> 
  </tr> 
  <tr> 
   <td>${TIME}</td> 
   <td>current system time</td> 
  </tr> 
  <tr> 
   <td>${YEAR}</td> 
   <td>current year</td> 
  </tr> 
  <tr> 
   <td>${MONTH}</td> 
   <td>current month</td> 
  </tr> 
  <tr> 
   <td>${MONTH_NAME_SHORT}</td> 
   <td>first 3 letters of the current month name. Example: Jan, Feb, etc.</td> 
  </tr> 
  <tr> 
   <td>${MONTH_NAME_FULL}</td> 
   <td>full name of the current month. Example: January, February, etc.</td> 
  </tr> 
  <tr> 
   <td>${DAY}</td> 
   <td>current day of the month</td> 
  </tr> 
  <tr> 
   <td>${DAY_NAME_SHORT}</td> 
   <td>first 3 letters of the current day name. Example: Mon, Tue, etc.</td> 
  </tr> 
  <tr> 
   <td>${DAY_NAME_FULL}</td> 
   <td>full name of the current day. Example: Monday, Tuesday, etc.</td> 
  </tr> 
  <tr> 
   <td>${HOUR}</td> 
   <td>current hour</td> 
  </tr> 
  <tr> 
   <td>${MINUTE}</td> 
   <td>current minute</td> 
  </tr> 
  <tr> 
   <td>${PROJECT_NAME}</td> 
   <td>the name of the current project</td> 
  </tr> 
 </tbody> 
</table>

### 2. 方法注释模板 ###

File -> Settings -> Editor -> Live Templates

1.在Live Templates 右侧点击+号，添加一个Templates Group，命名为 methodTemplates

![img][img 1]

![img][img 2]

2.在刚刚创建的 methodTemplates 下创建一个 Live Templates ，如下

![img][img 3]

1）、在位置1处： 输入模板的简写码  
在位置2处：输入模板的描述  
在位置3处： 输入方法注释模板样式，可变变量要用  **变 量 名 变量名 变量名** 来表示，如： p a r a m param param；  
若不设置成如此的变量名，位置4不可点击，模板如下：

/**
     * @title $title$
     * @author Kevin $param$
     * @updateTime $date$ $TIME$ $return$
     * @throws $throws$
     */

点击位置4处：可编辑定义的变量的值，如下：

![img][img 4]

变量param 为方法的参数变量，需要根据方法的参数多少进行变化；变量 return 为返回值类型，也要根据方法的返回值进行变化，所一要自行设置该方法，设置的代码如下，复制粘贴即可：

**param :**

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

**return :**

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return: ' + data; }; return result;", methodReturnType())

在位置3下方，点击选择该模板应用的范围，可选Everywhere 表示任何位置都可添加该注释

![img][img 5]

点击options 中的 Expand with 可选择该模板配合使用的快捷键，如 Tab键，Space 空格键 ， Enter 回车键 等等；

如在这里设置的模板关键词为 \* ，配合使用快捷键为Tab键  
则在方法中输入 \* ，在按下Tab 键，即可按照模板生成注释。

![image-20220512154405338][]

##### 补充说明 #####

方法注释模板不可用在，方法外，若用在方法外 @param 获取不到，注释为 @param null;

类注释模板在文件创建时生成，已创建文件不会触发该模板，会触发方法注释模板。

[img]: https://img-blog.csdnimg.cn/img_convert/46e0edd9409c170c9c8ebaf5dcafc749.webp?x-oss-process=image/format,png
[image-20220512152855134]: https://img-blog.csdnimg.cn/img_convert/ba7dd726690b7c6da600a363d9280866.png
[img 1]: https://img-blog.csdnimg.cn/img_convert/878f01e48f558973629ec4aa59a6920d.webp?x-oss-process=image/format,png
[img 2]: https://img-blog.csdnimg.cn/img_convert/a6b9e974010c565d056b63e46c1d26af.webp?x-oss-process=image/format,png
[img 3]: https://img-blog.csdnimg.cn/img_convert/40e39e0312ebe0ba8b6869c3b3f21622.webp?x-oss-process=image/format,png
[img 4]: https://img-blog.csdnimg.cn/img_convert/68e751b57c430b2e18ad8e020c73a832.webp?x-oss-process=image/format,png
[img 5]: https://img-blog.csdnimg.cn/img_convert/c461ba222a0cc8a8ad543be5adf2aa5f.webp?x-oss-process=image/format,png
[image-20220512154405338]: https://img-blog.csdnimg.cn/img_convert/57c45e776b14409533d4e61b04c33c13.png