IDEA中对类和方法注释模板的设置 (保姆级教程)

LXHYouth

已于 2024-03-18 11:52:22 修改

阅读量2.7k

点赞数 24

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

于 2024-03-05 11:54:13 首次发布

本文链接：https://blog.csdn.net/qq_42013947/article/details/136473382

版权

2 篇文章 0 订阅

订阅专栏

本文介绍了如何在IntelliJIDEA中设置类注释和方法注释模板，包括自动添加类名、作者、日期、版本等信息，以及如何创建和应用自定义的注释快捷方式，以提升编程效率。

摘要由CSDN通过智能技术生成

1. 类注释模板

/**
 * @className: ${NAME}
 * @author: LXHYouth
 * @date: ${DATE} ${TIME}
 * @Version: 1.0
 * @description:
 */

IDEA目前还没有支持自动添加方法注释, 那就要自己手动写好添加一下.
位置: File → Settings → Editor → Live Templates
点击右侧的 + 先创建一个一个分组: 可以先命名为 userDefine
找到刚刚创建的 userDefine 分组, 点击一下, 然后点击 + 号创建一个模板.
由于IDEA默认生注释的方式为: /*加Tab, 那我们就可以延用一下, 可以把模板缩写(Abbreviation)填 * , 当然如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType(), Description: 是模板的解释说明. Template text: 需要注释的模板内容. 可以直接复制过去.
Abbreviation: *
Description: Add Comments for method.

Template text:

*
* @Author LXHYouth
* @Description 
* @Date $time$ $date$
* @Param $param$
* @return $return$
**/

设置一下应用场景, 由于我是用Java语言编写代码, 那么范围直接选Java就可以了. 没设置过的是 Define (如果修改过的就是change) , 点击一下选择Everything → Java
现在设置一下参数, 选择右侧的Edit variables按钮
注意：一定要按顺序来, 不可颠倒，不然这里就获取不到方法
可以按如下设置:
保存一下 Apply → OK
现在去测试一下效果, 嗯!!! 非常成功.

Template text:

/**
* @author: LXHYouth
* @date: $date$ $time$
* @Version:    1.0
* @Description
**/

这里我把模板缩写(Abbreviation)填小写的 l , 就是我名字的第一个开始的字母 (这么设置就是为了速度快), 然后按之前步骤一次填入和设置. 最后保存一下.
测试一波: 快速添加个人基本信息. 比如刚刚老师下发的作业题, 在package包代码下行添加自己的基本信息, 直接输入一个 l 加 Tab键就添加成功了.
到此教程就结束了.
转载: 请附上本文链接.
如果文章对你有帮助, 可以点赞收藏一下, 以防下次需要可以快速找到.