IDEA设置类与方法注释

设置类注释

进入设置页面

依次选择: File --> Settings --> Editor --> File and Code Templates
如图

修改注释格式

可以看到Files里面有一个代表java语言的文件,选择class后看到最右边有一个输入框,它是设置的脚本的,我叫做脚本输入框,下边有一个description框,哪里面写有一些可以用到的值

在class的脚本输入框里面,可以看到里面有一句话

#parse("File Header.java")

这句话的意思是这个位置的内容引用Header.java文件中的内容,这个位置是在class的上方,
例:

package com.xxx.demo.doctest;

//我就是这个位置
public class Test {
}

在这里有两种添加注释的方式

1. 直接在class脚本文件中添加注释(优点:可单独针对不同类型添加特有注释)
2. 在引用的Header文件中添加注释(优点:简单,覆盖多类型,类似于基类的概念)

有需要也可以两种结合,两种方式不冲突.引用的Header文件中添加基础的信息,单独类别中添加特有信息

方式一

直接在class脚本文件中改
例:

代码片段

/**
*@Author ${USER}
*@Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

设置完成后点击Apply就可以了

方式二

在引用的Header文件中添加注释

引用的Header文件在上方Files选项旁有一个Includes选项

在引用文件的脚本输入框内填入自己想加入的信息,内容如上图(我已经添加好了)
代码片段

/**
*@Author ${USER}
*@create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

设置完成后点击Apply就可以了

使用方法

在新建类时注释自动就添加了,不需要额外操作 ^ _ ^

设置方法注释

进入设置页面

依次选择: File --> Settings --> Editor --> Live Templates --> other —> 点击添加按钮
页面如图

创建条目

当点击完添加按钮后会弹窗选项框,Live Temlpate条目(创建单条)
注意:
下面的template Group是创建分组

设置条目

当点击完Live Template按钮后界面会变为如下的状态

设置步骤:
脚本名:
设置会触发的此脚本的先决条件(我设置的是doc,也有人会就设置一个*)
脚本说明:
这个随便写
脚本具体的格式:
这个是就样式了

*
*@return $return_type$
*@Param $params$
*@Author $author$
*@Date $date$ $time$
**/

选择可触发类型:
选择EveryWhere(全选)就可以(作用就是监听你在对应类型的文件中的输入是否可触发此脚本)
选择触发按钮:
当你连续输出脚本名后,按下触发按钮就会开始执行脚本,我选择的是Enter

最后点击 Edit Variables按钮,此按钮是设置脚本格式中参数($参数$)怎么获取以及默认值,
界面如下:

Name列是参数名
Expression列是获取方法(此列可不需要手动输入,可以点击后出现选择下拉框,选择对应的就可以)
Default value列是默认值(可以不输入)
Skip if defined列,定义时是否略过(这个目前我也不知道什么作用,先全选中吧)

设置完成如图:

最后点击OK 和 apply就可以了

使用方法

在方法的上方输如/*后输入脚本名,最后按下设置的触发按钮

前面的/*很重要,脚本自身你只要输入脚本名后就会提示有快捷键可以使用,但是这样是无法获取到方法的参数以及返回值的,有人会在方法内部生成注释后在复制到方法上方,我觉着很麻烦就使用了这样的方法.

看下最后的效果