开发工具IDEA——增加注释快捷按键

简介: 之前我进行设置了[开发工具IDEA——创建类或方法注释](),但是有时我们的类文件或者方法已经存在了,我只是想补充一下注释,这时我们就需要使用到快捷键进行注释了,对此,我们需要配置一个符合于我们自己注释格式的快捷键,下面我们就开始进行配置。

开发工具IDEA——增加注释快捷按键

简介

开发工具IDEA系列文章是我在进行Java开发时使用IDEA开发工具一些设置和其调整,特将其整理出来分享给大家,特别适合于刚接触开发或者刚重新安装开发工具的小伙伴们,可以根据这一系列文章将IDEA工具调校成为自己的左膀右臂,助力自己的Java开发。

环境

  • 系统:windows10
  • 开发工具:IDEA
  • 语言:Java

内容

之前我进行设置了[开发工具IDEA——创建类或方法注释](),但是有时我们的类文件或者方法已经存在了,我只是想补充一下注释,这时我们就需要使用到快捷键进行注释了,对此,我们需要配置一个符合于我们自己注释格式的快捷键,下面我们就开始进行配置。

1、打开IDEA进入File——Setting——Editor——Live Templates

点击右侧的+号,选择Template Group模板分组添加

1.png

2.png

2、选择刚添加的分组,再次点击右侧的+号,选择Live Template进行添加一个代码模板,并添加基础信息

3.png

其中Template text使用的代码如下,可根据自己的需求进行灵活调整。

**
* <p> </p>
* @date $data$ $time$
$params$
* @return $return$
* @throws $throws$
* @version 1.0
* @author $user$
*/

3、点击Edit variables 进行设置刚才在Template text中使用的一些变量对应的值或方法。

4.png

5.png

其中params使用的是如下自定义方法:

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

4、进行设置触发方式为回车Enter

6.png

5、进行设置生效的范围

7.png

8.png

到达这里,我们就可以在方法上方进行实现输入/*然后按下回车键实现注释根据方法进行生成了。


下面我再次分享一下我设置的用于方法快捷键和用于类注释快捷键的模板内容

方法函数

**
* <p> </p>
* @date $data$ $time$
$params$
* @return $return$
* @throws $throws$
* @version 1.0
* @author $user$
*/

9.png

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

类头部

**
 * 类 {@code $NAME$} 补充名称 <br> 补充简述.
 *
 * Copyright (c) 版权所有 <a href="https://blog.cnhuashao.com">CN華少</a><br>
 * @since v1.0.0
 * @version v1.0.1 $data$ $time$
 * @author <a href="mailto:lz2392504@gmail.com">$user$</a>
 * @see 相关联的类,每个类或方法单独一个@see标签
 * @TODO 代办事项的标记
 */

10.png


本文声明:

5330898-d1c72b6c90e378f3.png
知识共享许可协议
本作品由 cn華少 采用 知识共享署名-非商业性使用 4.0 国际许可协议 进行许可。

目录
相关文章
|
2天前
|
SQL 存储 关系型数据库
MySQL 与 IntelliJ IDEA 同时兼容的注释
MySQL 与 IntelliJ IDEA 同时兼容的注释
7 2
|
2月前
|
XML 数据格式
IDEA 行注释设置,使其不从顶格开始,让其处于代码前开始
这篇文章提供了IntelliJ IDEA中如何设置行注释不从顶格开始,而是紧接在代码前面的方法,通过访问Settings中的Code Style选项进行调整,以改善代码注释的视觉效果。
IDEA如何设置取消 请不要使用行尾注释 提示
文章介绍了如何在 IntelliJ IDEA 中设置以取消行尾注释的提示。这个问题通常由使用阿里规范插件导致,插件会在不满足规范时在代码中显示黄色波浪线提示。为了改善代码编辑体验,文章提供了详细的步骤说明,指导用户通过进入 "File" -> "Settings" -> "Editor" -> "Inspections" 来取消特定检查项,从而消除这些提示。修改设置后,代码界面将不再显示黄色波浪线,看起来更加清爽。
IDEA如何设置取消 请不要使用行尾注释 提示
|
2月前
IDEA——代码文件如何插入作者注释
IDEA——代码文件如何插入作者注释
36 0
|
2月前
Intellij idea 生成带注释的get/set
Intellij idea 生成带注释的get/set
76 0
|
4月前
|
Linux 开发工具 Windows
在WSL2中安装IntelliJ IDEA开发工具
在WSL2中安装IntelliJ IDEA开发工具
413 2
|
4月前
idea 自动加头部注释
idea 自动加头部注释
28 2
|
5月前
|
XML Java 数据格式
idea注释顶格不美观的问题--代码与XML
idea注释顶格不美观的问题--代码与XML
43 6
|
5月前
Mac上IntelliJ IDEA设置类注释和方法注释带作者和日期
Mac上IntelliJ IDEA设置类注释和方法注释带作者和日期
308 0
|
5月前
idea生成方法注释的正确方法
idea生成方法注释的正确方法

热门文章

最新文章