IDEA的类注释和方法注释详解

最新推荐文章于 2025-04-01 10:03:31 发布

「已注销」

最新推荐文章于 2025-04-01 10:03:31 发布

阅读量1k

点赞数

分类专栏： IDEA 文章标签： intellij-idea java ide

本文链接：https://blog.youkuaiyun.com/l546492845/article/details/126597173

版权

本文详细介绍了如何在IntelliJ IDEA中设置类注释和方法注释。通过File > Settings进入配置，调整File and Code Templates及Live Templates，设置模板、显示方式和快捷键，以实现快速生成和编辑类及方法的注释。了解这些步骤，可以提升代码注释的效率和规范性。

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

IDEA自动生成类和方法注释

一、类注释效果展示
- 设置步骤
二、方法注释效果展示
- 设置步骤

一、类注释效果展示

在这里插入图片描述

设置步骤

1、File一>Settings

在这里插入图片描述

2、Editor 一> File and Code Templates 一> Files 一> Class

在这里插入图片描述

3、类注释模板

/** 
* @author: 探长々 
* @date: ${YEAR}年${MONTH}月${DAY}日 ${TIME} 
* @ClassName: ${NAME}
* @Description: TODO
*/

二、方法注释效果展示

在这里插入图片描述

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

「已注销」

关注关注

0
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

IDEA类注释和方法注释

Java_Glory的博客

10-26

587

效果图：类注释: /** * @Name: ${NAME} * @Description: ${description} * @Author: *** * @CreateDate: ${YEAR}-${MONTH}-${DAY} ${TIME} * @Version: 1.0 */ 方法注释: 新增一个模板分组：找到上面建的模板分组，创建模板：定义方法的模板注释： * * @author: dzr * @date: $date$...

IDEA设置类注释和方法注释

Louka的专栏

07-18

8622

注意如果idea版本在2020.3以下，会在Expression获取时缺失methodParameterTypes()方法，得到的参数类型会为null。description不勾选Skipifdefined时自动补全注释后光标停留在注释第一行，填写方法描述，默认用Tab键自动补全代码，如果想用Enter自动补全代码，点击右边的ExpandWith，换成Enter即可。应用后新建文件时，会自动添加作者，创建时间，描述的注释。接口被调用处，鼠标移到方法上，自动显示注释描述的信息。......

参与评论您还未登录，请先登录后发表或查看评论

idea如何设置类头注释和方法注释

07-14

类、类属性、类方法的注释必须使用javadoc规范，使用/**内容*/格式，不得使用//xxx方式和/*xxx*/方式。说明：在IDE编辑窗口中，javadoc方式会提示相关注释，生成javadoc可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

IDEA 类注释和方法注释

zhr19970910的博客

03-16

1301

idea 有用的技巧

IDEA 注释模板这样搞！爽！

最新发布

方志朋的博客

04-01

在无返回值的情况下会返回 void，这并没有什么意义，因此我对 methodReturnType() 返回值进行了处理，仅在有返回值时才生成。这样的参数，此时 IDEA 还不认识这些参数是啥玩意，下面我们对这些参数进行方法映射，让 IDEA 能够明白这些参数的含义。属性，它的意思是如果在生成注释时候如果这一项被定义了，那么鼠标光标就会直接跳过它。在我提供的示例模板中，说明了作者和时间，IDEA 支持的所有的模板参数在下方的。答：因为我习惯在这一行写方法说明，所以就预留了一行空的写，你也可以把它删掉。

IDEA：类注释和方法注释

拒绝熬夜啊的博客

09-05

1130

IDEA：类注释和方法注释

IDEA 中自定义设置类注释和方法注释(详解)

myStyle的博客

07-24

1万+

在网上看了很多都太乱，而且说的不清楚，操作后没有效果，这里我整理一个详细的傻瓜式的操作一、IDEA中设置注释模板主要分为两个部分，分别是类的注释和方法的注释。 1、选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→File Header文件。 1、选择File→Settings→Editor→File and C

IDEA 类和方法的注释

一个有故事的程序员

01-01

3782

IDEA 如何设置类和方法的注释快捷键一、设置类的注释（1）打开file->setting->Editor->Filr and Code Templates->Includes->File Header，如下图1所示：图1 （2）在右边黑框内复制粘贴一下代码1：代码1： /** * @description: * @author: ManolinCoder * @time: ${DATE} */ 保存之后,当你创建类的时候就会自动生

IDEA类和方法注释模板设置（非常详细）

08-27

"IDEA类和方法注释模板设置详解" 通过本篇文章，我们将详细介绍IDEA类和方法注释模板设置的方法。首先，我们需要了解为什么需要使用模板来生成注释。在编程过程中，我们经常需要编写注释来解释代码的含义和作用，...

详细介绍idea如何设置类头注释和方法注释(图文)

08-28

IntelliJ IDEA 设置类头注释和方法注释详解 IntelliJ IDEA 是一款功能强大且功能丰富的集成开发环境（IDE），它提供了许多实用的功能来帮助开发者提高编码效率。其中，设置类头注释和方法注释是 IDEA 中的一个重要...

Idea自定义方法注释模板的教程详解(去param括号、return全类名)

08-18

Idea自定义方法注释模板教程详解 Idea自定义方法注释模板是IntelliJ IDEA中的一种功能，可以帮助开发者快速生成方法注释，提高代码的可读性和维护性。本文将详细介绍Idea自定义方法注释模板的创建和配置过程，包括...

详解IDEA自定义注释模板(javadoc)

08-27

IDEA自定义注释模板(javadoc)...本文详细介绍了自定义IDEA注释模板的两种解决方案：安装Jindent插件和使用IDEA自带的Live Template模板设置。通过这些方法，可以轻松地自定义注释模板，提高代码的可读性和可维护性。

IDEA 类和方法注释模板设置(Windows版).pdf

08-19

### IDEA类和方法注释模板设置知识点详解 #### 类注释模板设置 1. **模板作用** 类注释模板的作用是在创建Java类文件时，自动添加标准注释信息，从而规范代码结构，提高代码的可读性和可维护性。 2. **设置流程*...

IDEA 自定义注解(类注释、方法注释)

热门推荐

lydms的博客

12-07

3万+

文章目录一、生成类注释1、打开设置位置2、将自定义的类注解规则，复制到Class中。3、使用：新建类的时候会自动加上注解二、自定义方法注解1、打开设置2、添加自定义注解模板组3、添加自定义注解模板4、设置模板的作用范围5、自定义㢟规则6、使用自定义注解三、注意事项1、在类上注解，没有显示入参和返回值2、自定义注解参数及使用方式一、生成类注释 1、打开设置位置打开File —> Settings —> Editor —> File and Code Templates —> Fi

IDEA 生成类和方法的注释信息

qq_45752401的博客

04-25

9406

新建Class类，自动生成注释信息新建任意类，自动生成注释信息新建方法，自动生成注释信息 1. 新建class类，自动生成注释信息打开File -> Settings -> Editor -> File and Code Templates -> Files，找到class，然后输入如下信息即可。 /** * @author: myqxin * @Desc: * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} **/ 2

IDEA设置JAVA类和方法自定义注释模板方法

晨港飞燕的专栏

12-30

5703

IDEA生成注释的方式是：模板名+快捷键（比如设置模板名为a,快捷键用Tab，则生成方式为a+Enter），可以根据这个来选择使用不同的模版注释。日期格式:${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}:${SECOND}相关的，我们可以用IDEA内置的表达式，然后传入自己的格式化规则字符串即可。，因为会造成方法参数无法获取，我们在方法上面生成注释时，需要先写斜杠，然后再输入。Name：是Template text中的变量名，就是双$符中间的变量。

IDEA设置类注释和方法注释模板

灵活的小胖子

02-01

667

模板是将一个事物的结构规律予以固定化、标准化的成果，它体现的是结构形式的标准化。---百度百科很多公司或组织都有各自的代码注释规范，我们每新建类或者方法的时候如果每次重新写或者从以前的地方复制粘贴过来很麻烦，而且很容易出错。那么，设置类注释和方法注释模板就应运而生啦！其实，大家都知道，在idea中输入sout+Enter键，就会变成system.out.print()，输入psvm，就会变成public static void main （String[] args）{},其实，这也是模板的作用。下

【idea】idea方法注释

不想睡觉的橘子君的博客

02-12

962

不过在具体的使用中，使用idea自带模板和groovy表达式的时候，模板中是否带有@param@return，是有细微的区别的，这一点读者可以自行验证。注意，上面的模板和别的文章里的不太一样，是因为我自己做了一些改动。别的文章里的模板，使用注释需要 / 加上星号或者2个星号，再加上缩写，最后Tab补齐，才能产生注释。网上有很多类似的文章，但是我在按照他们的文章设置后，出现了一些问题，因此我这边在解决了问题后，总结一篇文章，发出来给大家借鉴一下。此外，一定注意复制模板的时候，第一行是2个*。

IDEA类和方法的注释规范（超级实用）

m0_58386652的博客

04-06

1070

我们都知道要做好项目，注释的规范也必不可少，所以本文给出类和方法的注释规范