idea设置类注释和方法注释（2019.2.3版本）

原创已于 2022-08-23 14:29:24 修改 · 793 阅读

2 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#java

于 2021-07-12 16:24:23 首次发布

idea和dataGrip工具使用专栏收录该内容

12 篇文章

订阅专栏

本文档详细介绍了如何在IntelliJ IDEA中配置类和方法的自动注释模板。步骤包括进入设置，找到相应目录，设定类注释和方法注释的模板内容及快捷键，以便于提高开发效率和代码规范。类注释模板包含作者和创建日期，方法注释模板则包括描述、作者、日期及参数注释。设置完成后，新建类会自动生成类注释，而方法注释需要通过快捷键触发。

1、设置类和接口等注释（新建文件的时候生效）

（1），打开idea，然后找到FIle—>Settings
在这里插入图片描述
（2），找到对应的目录

（3）类注释代码：自己也可以调格式

/**
* @author: 你的名字
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

2、方法上的注释

（1），首先我们自己建立一个分组

在这里插入图片描述
（2），创建分组模板，名字随便起，下面设置注释快捷键方式，我习惯使用
/**+Enter，可以按照自己的习惯调试
方法注释模板：可以自己调节格式，最好按这个格式来，看着比较整齐

**
 * @Description:
 * @Author: 王乾
 * @Date: $date$ $time$
 $param$
 **/

在这里插入图片描述

（3）设置完上面以后点击下面的，选择java下的应该就可以，其他估计用不到

（4）参数排版自己从网上找的，网友们也可以自行寻找

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ': '}else{result+='\\n' + ' * @param ' + params[i] + ': '}}; return result;}", methodParameters());

在这里插入图片描述
3、到此就已经设置完了，类注释是自己创建类的时候自动生成，方法的注释需要自己手动敲快捷键，自己生成，哪里不对的请指出，自己测试是可以用，如果不能用，最大可能就是设置有问题，还有可能是idea版本问题