Idea的类注释和方法注释

墨蓝 2023-09-28 14:00 78阅读 0赞

#### Idea的类注释和方法注释 ####

*   *  1.IDEA中在创建类时会自动给添加注释
     *  2.在方法的上面一行输入/\*然后回车，就有方法的注释设置如下

idea不会默认帮我们设置，所以需要手动设置。

### 1.IDEA中在创建类时会自动给添加注释 ###

打开idea,操作

File–>settings–>Editor–>File and Code Templates–>Files  
![在这里插入图片描述][d479aa8d96b54c3984dc1265de290508.png]

（1）NAME：设置类名，与下面的NAME：设置类名，与下面的\{NAME\}一样才能获取到创建的类名

（2）TODO：代办事项的标记，一般生成类或方法都需要添加描述

（3）USER、USER、\{DATE\}、TIME：设置创建类的用户、创建的日期和时间，这些事IDEA内置的方法，还有一些其他的方法在红色框标注的位置，比如你想添加项目名则可以使用TIME：设置创建类的用户、创建的日期和时间，这些事IDEA内置的方法，还有一些其他的方法在红色框标注的位置，比如你想添加项目名则可以使用\{PROJECT\_NAME\}

/**
    * @descript  描述
    * @author 王哈哈 
    * @date ${YEAR}-${MONTH}-${DAY}
    */

![在这里插入图片描述][16fb06731d104a14972e210adf4cded9.png]

### 2.在方法的上面一行输入/\*然后回车，就有方法的注释设置如下 ###

IDEA还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，使用Eclipse时我们生成注释的习惯是

/\*\*+Enter，这里我们也按照这种习惯来设置IDEA的方法注释

File–>Settings–>Editor–>Live Templates  
**（1）新建组：命名为userDefine**  
![在这里插入图片描述][f324b0b07e8d4a33bfd2d17a510cdf60.png]  
**（2）选中userDefine在其目录下新建模板：命名为**\*

因为IDEA生成注释的默认方式是：/\*+模板名+快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为 /\*add+Tab），如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters(）、获取方法返回值的methodReturnType(）

**（3）设置生成注释的快捷键**(注：此处需注意首行没有 / ，且 第一个\*是顶格的)

*
     * @Author 王哈哈
     * @Description //TODO $end$
     * @Date  $date$ $param$ $return$
     */

![在这里插入图片描述][9b43ac5cbcde4705bcfdb393a167b488.png]  
![在这里插入图片描述][a4d632616ac442738d9aba5576c6e109.png]  
date直接使用下拉框选择就可以了，而 param和return 这两个参数 IDEA 默认的实现很差，因此我们需要手动实现  
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("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

> 注：你还注意到我并没有勾选了 Skip if defined  
> 属性，它的意思是如果在生成注释时候如果这一项被定义了，那么鼠标光标就会直接跳过它。我并不需要这个功能，因此有被勾选该属性。

最后效果图 输入 /\*\*+enter  
![在这里插入图片描述][06af146503a24404a860da25eb34f5cc.png]

[d479aa8d96b54c3984dc1265de290508.png]: https://img-blog.csdnimg.cn/d479aa8d96b54c3984dc1265de290508.png
[16fb06731d104a14972e210adf4cded9.png]: https://img-blog.csdnimg.cn/16fb06731d104a14972e210adf4cded9.png
[f324b0b07e8d4a33bfd2d17a510cdf60.png]: https://img-blog.csdnimg.cn/f324b0b07e8d4a33bfd2d17a510cdf60.png
[9b43ac5cbcde4705bcfdb393a167b488.png]: https://img-blog.csdnimg.cn/9b43ac5cbcde4705bcfdb393a167b488.png
[a4d632616ac442738d9aba5576c6e109.png]: https://img-blog.csdnimg.cn/a4d632616ac442738d9aba5576c6e109.png
[06af146503a24404a860da25eb34f5cc.png]: https://img-blog.csdnimg.cn/06af146503a24404a860da25eb34f5cc.png