idea常用注释模板

一、类注释

打开 IDEA 的 Settings,点击 Editor–>File and Code Templates,点击右边 File 选项卡下面的 Class,在其中添加图中红框内的内容:

/**
 * @author jitwxs
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */

在这里插入图片描述
在提供的示例模板中,说明了作者和时间,IDEA 支持的所有的模板参数在下方的 Description 中被列出来。

保存后,当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效,同时配置上图中的 Interface 项即可。

二、方法注释

不同于目前网络上互相复制粘贴的方法注释教程,本文将实现以下功能:

  • 根据形参数目自动生成 @param 注解
  • 根据方法是否有返回值智能生成 @Return 注解

相较于类模板,为方法添加注释模板就较为复杂,首先在 Settings 中点击 Editor–>Live Templates。
点击最右边的 +,首先选择 2. Template Group… 来创建一个模板分组:
在这里插入图片描述
在弹出的对话框中填写分组名,我这里叫做 userDefine:
在这里插入图片描述
然后选中刚刚创建的模板分组 userDefine,然后点击 +,选择 1. Live Template:
在这里插入图片描述
此时就会创建了一个空的模板,我们修改该模板的 Abbreviation、Description 和 Template text。需要注意的是,Abbreviation 必须为 *,最后检查下 Expand with 的值是否为 Enter 键。
在这里插入图片描述
上图中· Template text 内容如下,请直接复制进去,需要注意首行没有 /,且 * 是顶格的。

*
 * 
 * @author jitwxs
 * @date $date$ $time$$param$ $return$
 */

注意到右下角的 No applicable contexts yet 了吗,这说明此时这个模板还没有指定应用的语言:
在这里插入图片描述
点击 Define,在弹框中勾选Java,表示将该模板应用于所有的 Java 类型文件。
在这里插入图片描述
设置 applicable contexts

还记得我们配置 Template text 时里面包含了类似于 d a t e date date 这样的参数,此时 IDEA 还不认识这些参数是啥玩意,下面我们对这些参数进行方法映射,让 IDEA 能够明白这些参数的含义。点击 Edit variables 按钮:
在这里插入图片描述
为每一个参数设置相对应的 Expression:
在这里插入图片描述
设置 Expression

需要注意的是,date 和 time 的 Expression 使用的是 IDEA 内置的函数,直接使用下拉框选择就可以了,而 param 这个参数 IDEA 默认的实现很差,因此我们需要手动实现,代码如下:

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

另外 return 这个参数我也自己实现了下,代码如下:

groovyScript("return "${
   _1}" == 'void' ? null : 'rn * @return ' + "${
   _1}"", methodReturnType())

注:你还注意到我并没有勾选了 Skip if defined 属性,它的意思是如果在生成注释时候如果这一项被定义了,那么鼠标光标就会直接跳过它。我并不需要这个功能,因此有被勾选该属性。

参考网址:IDEA这样配置注释模板,让你高出一个逼格!!

相关推荐

  1. IDEA模板

    2024-02-01 08:22:03       30 阅读
  2. idea配置——注释快捷键

    2024-02-01 08:22:03       38 阅读
  3. springboot注释

    2024-02-01 08:22:03       35 阅读
  4. IDEAIDEA快捷键

    2024-02-01 08:22:03       32 阅读
  5. IDEA快捷键

    2024-02-01 08:22:03       58 阅读
  6. IDEA 快捷键

    2024-02-01 08:22:03       62 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-02-01 08:22:03       94 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-02-01 08:22:03       100 阅读
  3. 在Django里面运行非项目文件

    2024-02-01 08:22:03       82 阅读
  4. Python语言-面向对象

    2024-02-01 08:22:03       91 阅读

热门阅读

  1. Hadoop-MapReduce-源码跟读-ReduceTask阶段篇

    2024-02-01 08:22:03       53 阅读
  2. HG/T 3830-2022 预涂卷材涂料检测

    2024-02-01 08:22:03       53 阅读
  3. 物流无人机在哪些场景最适合应用?

    2024-02-01 08:22:03       45 阅读
  4. Flink 集成和使用 Hive Metastore

    2024-02-01 08:22:03       55 阅读
  5. C++ 结构体的构造函数

    2024-02-01 08:22:03       50 阅读
  6. 面阵相机拍摄运动的物体怎样保证图像清晰

    2024-02-01 08:22:03       63 阅读
  7. TensorFlow2实战-系列教程14:Resnet实战2

    2024-02-01 08:22:03       63 阅读
  8. 3D Gaussian Splatting-实时辐射场渲染技术

    2024-02-01 08:22:03       49 阅读
  9. TensorFlow2实战-系列教程15:Resnet实战3

    2024-02-01 08:22:03       65 阅读