IDEA类和方法注释模板设置

最新推荐文章于 2025-07-03 16:20:32 发布

原创最新推荐文章于 2025-07-03 16:20:32 发布 · 8.3k 阅读

10 ·

CC 4.0 BY-SA版权

IDEA 专栏收录该内容

5 篇文章

订阅专栏

本文详细介绍如何在IntelliJ IDEA中配置类和方法的注释模板，包括自定义注释格式、设置快捷键及应用范围等内容。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

这里设置的注释模板采用Eclipse的格式，下面先贴出Eclipse的注释模板，我们就按照这种格式来设置：

类注释模板：

/***
 * @ClassName: TestType
 * @Description:
 * @Auther: cyj
 * @Date: 2018/7/9 09:08
 * @version : V1.0
 */

方法注释模板：

/**
 * @Title
 * @Description: TODO
 * @auther: Administrator
 * @date: 2018/7/9 9:10
 * @return: java.lang.String
 */

一、首先我们来设置IDEA中类的模板：（IDEA中在创建类时会自动给添加注释）

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

我们选择Class文件（当然你要设置接口的还也可以选择Interface文件）

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

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

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

（4）1.0：设置版本号，一般新创建的类都是1.0版本，这里写死就可以了
这里写图片描述

二、设置方法注释模板

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

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

1、File–>Settings–>Editor–>Live Templates
这里写图片描述

（1）新建组：命名为userDefine
这里写图片描述

（2）新建模板：命名为*

因为IDEA生成注释的默认方式是：/*+模板名+快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为

/*add+Tab），如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters(）、

获取方法返回值的methodReturnType(）
这里写图片描述

（3）设置生成注释的快捷键
这里写图片描述

（4）设置模板：模板内容如下

注意第一行，只有一个而不是/

在设置参数名时必须用 ${参数名}$ 的方式，否则第五步中读取不到你设置的参数名
* * @Author chengpunan * @Description //TODO $end$ * @Date $time$ $date$ * @Param $param$ * @return $return$ **/
（5）设置参数的获取方式