IDEA2019.3.3设置Java类(class)和方法(method)注释模板

最新推荐文章于 2023-02-03 14:22:02 发布

闪电如风雨

最新推荐文章于 2023-02-03 14:22:02 发布

阅读量1.5k

点赞数

分类专栏： Java 文章标签： java

本文链接：https://blog.csdn.net/shanjian341622/article/details/105340815

版权

Java 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

我们都知道，在平常的开发过程中，一个类的注释量可以让我们快速了解这个类的作用，官方文档也说明一个类的注释量占整个类的70%，足以可以看到注释对一个类的重要性。这篇文章可以快速让你生成类、接口和方法的注释，提高编码效率，需要的朋友可以参考一下。

1、设置类的注释模板

IDEA设置类的路径如下：
File->Settings->Editor->File and Code Templates-> Includes-> File Header.
如下截图所示：
类的注释模板如下:

   /**
@Description: ${DESCRIPTION}
@Author: Janson # 我这里使用的是自己的英文名,大家使用${USER}直接获取系统用户名
@Date: ${DATE} ${TIME}
**/

2、设置方法的注释模板

IDEA设置方法的路径如下
File->Settings->Editor->Live Templates.
我们点击右边的+选项，选择1.Live Templates,新建自己的模板，可以在user组下的Abbreviation输入*，在Description输入方法注释模板(可选)，在Template text输入我们的模板内容。具体如下截图所示：
IDEA设置方法的variables
如下图所示：
方法的注释模板如下

/**
$params$
@return $return$
**/

方法的变量的params如下

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

3、类和方法的注释模板测试

通过下面的测试类可以看到，我们的类和方法的注释已经生效了，如下所示：

package com.test.annotation;

/**
 * @Description: 类、方法注释测试
 * @Author: Janson
 * @Date: 2020/4/6 13:01
 **/
public class ClassAnnotationTest {


	/**
	 * 测试方法的注释
	 * @param name 姓名
	 * @param age 年龄
	 * @return 返回String类型
	 */
	public String testMethodAnnotation(String name, Integer age) {
		return name + age;
	}

}