IDEA：类注释和方法注释

男娘i 2024-04-07 13:17 85阅读 0赞

## IDEA：类注释和方法注释 ##

### 一、类注释 ###

1.File–>settings–>Editor–>File and Code Templates–>Files

![在这里插入图片描述][6338b4f9657f4e4e959e8fe8fc1e7a2e.png_pic_center]

2.选择includes在空白处进行粘贴修改

/**
       * @ClassName ${NAME} 
       * @Description TODO
       * @Author hl
       * @Date ${DATE} ${TIME}
       * @Version 1.0
       */

![在这里插入图片描述][b2118b3a25184073a71f7a88871fd1ef.png_pic_center]

1.  实际效果

![在这里插入图片描述][302428dd5f9849779978948ec9405524.png_pic_center]

### 二、方法注释 ###

#### 1.创建模板 ####

File–>Settings–>Editor–>Live Templates

![在这里插入图片描述][46e30b062cca43bea79edeac2f4ea1e1.png_pic_center]

> methodTemplates 是我们的组名，然后在这个组下添加

![在这里插入图片描述][9a3af57ba3b94e068500e7e723acc766.png_pic_center]

#### 2.设置模板内容 ####

**
       * @MethodName $title$
       * @Description $description$ $param$ $return$ $throws$
       * @Author hl
       * @Date $date$ $TIME$
       */

> 代码的第一行必须要以\* \*开头，而不能以 / \* \*开头，否则会出现参数和返回值为空的情况

![在这里插入图片描述][89db4d81a5c44ec489e39d1e0525e0a6.png_pic_center]

#### 3.设置模板应用场景 ####

![在这里插入图片描述][99995689679b4d76bd9054f4d016f6a0.png_pic_center]

> 如果曾经修改过，则显示为change而不是define

#### 4.设置参数 ####

第3步和第4步顺序不可颠倒，否则第5步将获取不到方法

![在这里插入图片描述][05ea669d29c74da1b51e90f040bc64fa.png_pic_center]

> param

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

#### 三、去掉注释警告 ####

file-settings-editor-inspections-java-javadoc

![在这里插入图片描述][48fffd5ecffc45d78c2cf35740aa2adb.png_pic_center]

> 输入警告字段的名称

[6338b4f9657f4e4e959e8fe8fc1e7a2e.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/bf047bfda5de4329967c16b069effd5f.png
[b2118b3a25184073a71f7a88871fd1ef.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/615f5ba5132c4cdf9fec1d506f91955c.png
[302428dd5f9849779978948ec9405524.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/a9e08f42b96b4f9fb263443cae8f2bcb.png
[46e30b062cca43bea79edeac2f4ea1e1.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/58533935afe947268e5becebedbdc667.png
[9a3af57ba3b94e068500e7e723acc766.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/83fb0a0b6a9048f7b0f1dc60f4f993b5.png
[89db4d81a5c44ec489e39d1e0525e0a6.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/3b8b67b767ef4796b42f24c5344c1f45.png
[99995689679b4d76bd9054f4d016f6a0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/83fc4fade5e94fda88d86458098ff7c9.png
[05ea669d29c74da1b51e90f040bc64fa.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/5fa4b55010b34c4da8bead62d12d6063.png
[48fffd5ecffc45d78c2cf35740aa2adb.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/18aaeab7ea4b46369213e9d150e020af.png