IntelliJ Idea如何配置类和方法的注释模板

在写代码时为了提高可阅读性,我们经常需要给Java等语言的类及方法添加注释,这时为了提高效率我们就可以用到注释模板,本文将主要介
绍如何用Intelij Idea配置类及方法的注释模板提高代码注释效率。

一、准备工作

  • 01

    打开Idea,依次选择【File】--> 【Settings】

  • 02

    在设置界面的搜索框中输入live template查找到Live Templates配置项

  • 03

    点击最右侧的『+』号按钮,添加一个模板组,这里组名我们填写YC,这样就完成了一个模板组的创建,接下来我们将在这个模板组下创建类注释及方法注释模板。

二、配置类注释模板

  • 01

    选中模板组YC,在最右侧单击『+』号按钮,添加【Live Template】,输入模板基础信息(模板名称填写ccmt,模板介绍填写类注释模板),填写完成后单击第二张图片箭头指向处设置要针对的语言(这里我们只选择了Java和JavaScript)。

  • 02

    在如下方框内输入模板内容: /** * @Description:    java类作用描述 * @Author:         yc * @CreateDate:     $DATE$ $TIME$ * @UpdateUser:     yc * @UpdateDate:     $DATE$ $TIME$ * @UpdateRemark:   修改内容 * @Version:        1.0 */ 注意:可以根据需要设置更多变量,在接下来的步骤中给设置的变量配置相应的取值函数。

  • 03

    单击【Edit Variables】编辑变量,分别给上面的两个变量Date、Time设置取值函数date(),time(),设置完成后单击【OK】保存。

  • 04

    打开Java文件,在Java类上面输入ccmt后按下回车键即可快速添加类注释模板

三、添加方法注释模板

  • 01

    参照【 二、配置类注释模板】,添加方法注释模板,模板名称为mcmt,模板内容为: /** * 方法实现说明 * @author      作者姓名 $param$ * @return      $return$ * @exception   $exception$ * @date        $date$ $time$ */

  • 02

    点击上图的【Edit Variables】编辑变量,其中 param中填写Groovy脚本: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\\b' : '')}; return result", methodParameters()) 其他变量则从下拉框中直接选择下图对应的即可。

  • 03

    完成上面的模板配置后,在如下方法上面输入mcmt,然后按下Tab键或回车键就可以看到生成的方法注释喽!

(0)

相关推荐

  • 华为S5700怎么划分VLAN? S5700交换机配置VLAN的方法

    <Huawei>system-view 进入配置模式 Enter system view, return user view with Ctrl+Z. [Huawei]sysname ce ...

  • Win8设置自动配置脚本的方法

    Win8设置自动配置脚本的方法: 1、点击桌面右侧“设置”,选择“控制面板”,点击“网络和共享中心”; 2、点击“Internet 选项”; 3、点击“连接”中的“局域网设置”; 4、勾选“使用自动配 ...

  • 每次打开office2007都提示安装配置的解决方法

    最近,一些office2007用户反映说,打开office2007都会被提示需要安装配置,然而配置安装完毕,第二次打开office2007还是会提示.一些用户怀疑是不是office2007的注册码过期 ...

  • win10系统出现以太网没有有效的ip配置的解决方法

    许多用户对以太网这个新型的网络协议不是特别的了解,其实以太网我们可将它作为局域网来理解,这样用户就能够快速知道它的作用了,以太网的重要性在win10系统下是非常重要的,如果以太网配置不正确,可能会出现 ...

  • 交换机的VLAN配置步骤及方法

    交换机的VLAN配置步骤及方法 如图: 配置过程如下: 1.基本配置 步骤 交换机1命令 交换机2命令 作用 1 Switch>enable Switch>enable 进入特权模式 2 ...

  • cpu-z查看电脑配置数据的方法

    在之前的教程中,我们给大家介绍了CPU-Z的5大功能,使用CPU-Z可以查询电脑的处理器.缓存.主板.内存.显卡以及SPD的信息.不过,很多网友都不知道具体看哪一个项目,因此,在今天的教程中,我们就跟 ...

  • windows10系统电脑提示以太网没有有效的ip配置的解决方法图文教程

    使用Windows10正式版系统过程中,一些用户反映自己的电脑无法上网,使用[疑难解答]修复后遇到提示:“以太网”没有有效的IP配置,这该怎么解决呢?下面我们的小编带来windows10系统电脑提示以 ...

  • mpich2怎么安装 win7 64位系统下安装配置mpich2的方法教程

    mpich2是什么?mpich2怎么安装和配置?MPICH2 Windows是MPICH2在Windows环境下的安装包,能够帮助用户快速安装并配置MPICH2环境.MPICH2是与MPI-2相对应的 ...

  • 小米手机硬件配置信息查看方法

    相信很多小伙伴在使用手机时,都会好奇手机硬件的配置信息,那么如何去查看呢?下面小编就以小米手机为例,为大家具体介绍.具体如下:1. 首先打开手机上的拨号功能,进入通话页面,然后在电话号码输入处输入&q ...