IDEA类和方法注释模板设置全过程
一直在使用idea自带的注释模板，但是一直不太好用，最近在网上整理了一些比较完整的模板使用方法，来供大家学习使用，有不对的地方，欢迎大家在下方留言。
idea和eclipse的注释模板还是有一些差别的，下面就为大家介绍我整理的资料。
类注释模板：
/**
* @program: ${PROJECT_NAME}
* @ClassName ${NAME}
* @description:
* @author: lyy
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version 1.0
**/
public class ${NAME} {
}
方法模板注释：
/** @Author lyy * @Description //TODO $end$ * @Date $time$ $date$ * @Param $param$ * @return $return$ **/
一、类注释
操作： File -> Settings - > Editor -> File and Code Templates -> Files -> Class
在右边的文件框里编辑需要注释的模板，应用保存之后,当我们创建类的时候就会自动生成注释。
类注释模板：
/**
* @program: ${PROJECT_NAME}
* @ClassName ${NAME}
* @description:
* @author: lyy
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version 1.0
**/
public class ${NAME} {
}
1、如果要设置接口的，可以选择Interface文件
2、$ {PROJECT_NAME}：项目名，自动获取我们创建的项目名.
3、$ {NAME}：设置类名，与下面的$ {NAME}一样才能获取到创建的类名
4、TODO：代办事项的标记，一般生成类或方法都需要添加描述
5、$ {USER}：设置创建类的用户、创建的日期和时间，这些是IDEA内置的方法
6、$ {YEAR}-$ {MONTH}-$ {DAY} $ {HOUR} $ {MINUTE}：创建的日期和时间
7、@Version 1.0：设置版本号，一般新创建的类都是1.0版本
效果展示（当我们创建一个新类时，会自动添加注释）：
二、方法注释模板
方法模板注释：
/** @Author lyy * @Description //TODO $end$ * @Date $time$ $date$ * @Param $param$ * @return $return$ **/
操作： File -> Settings - > Editor -> Live Templates -> 点击"+"号 -> 选择 Template Group
2.1 新建组名
2.2 添加注释模板
2.3 点击 Define
2.4 选择 Everywhere ，这里我们选择java就行了
如果修改过，则显示为change而不是define
2.5 点击右下角的Edit variables
PS:2.4和2.5顺序不可颠倒，否则2.5将获取不到方法
2.6 效果图
注意使用方法注释需要在 方法内 进行，否则会显示Null
先写方法然后在方法上，输入"add"，按住tab注释就会自己出来了，大功告成！
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
SpringMVC中Controller层获取前端请求参数的方式汇总
这篇文章主要介绍了SpringMVC中Controller层获取前端请求参数的几种方式,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2023-08-08
在工作中,经常性的会出现在两张表中查找相同ID的数据,许多开发者会使用两层for循环嵌套,本文主要介绍了Java双重for循环的优化示例,感兴趣的可以了解一下2025-06-06
这篇文章主要介绍了java 如何读取远程主机文件的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-02-02
这篇文章主要为大家详细介绍了java控制台打印本月的日历，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2019-12-12
这篇文章主要介绍了Java高阶语法Volatile，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2019-03-03
乐观锁是一种并发控制机制,用于防止多个事务同时修改同一数据导致的数据不一致问题,它通过在数据记录中添加一个版本号或时间戳字段,来判断数据在两次操作之间是否被其他事务修改本文介绍了乐观锁防止数据冲突的详细过程2025-04-04
SpringBoot手动开启事务:DataSourceTransactionManager问题
这篇文章主要介绍了SpringBoot手动开启事务:DataSourceTransactionManager问题，具有很好的价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-07-07
构建模式主要用来针对复杂产品生产，分离部件构建细节，以达到良好的伸缩性,考虑到设计模式来源于建筑学,因此举一个建造房子的例子,需要的朋友可以参考下2012-12-12
在Java中处理异常并不是一个简单的事情,不仅仅初学者很难理解,即使一些有经验的开发者也需要花费很多时间,本文为大家整理了java处理异常Exception的一些常用方法,希望对大家有所帮助2023-09-09
这篇文章主要介绍了关于泛型擦除问题的解决--Mybatis查询类型转换方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-08-08
最新评论