[]

一、类注释

启动 IDEA 软件，进入主界面后，先选择“文件与代码”菜单，接着点击右侧的“文件”标签页，然后在其中找到并点击“类”选项，按照图示红框指示的内容进行添加。

/**
 * @author jitwxs
 * @date在${YEAR}年${MONTH}月的${DAY}日，${TIME}这一刻。
 */

在所提供的示例模板里，作者及其创作时间被明确指出，而IDEA所支持的各类模板参数，则详尽地罗列于下方表格之中。

在保存文件之后，每当您新建一个类intellij idea 配置，系统便会自动为其添加相应的类注释。若您希望此功能同样应用于接口，那么请同时调整并配置图中所示的相关选项。

二、方法注释

本文旨在提供一种与当前网络中流行的简单复制粘贴注释教程不同的方法，其具体功能包括：

与常规模板相比，给方法加入注释模板的过程显得更为繁琐，首先需要在菜单中找到并点击“Live”选项。

点击界面最右侧的加号按钮，初始步骤是挑选“2. Group...”选项，以此启动模板分组的创建过程。

在弹出的对话框中填写分组名，我这里叫做 ：

接着intellij idea 配置，挑选出先前建立的模板分组，之后按住加号，选取“1. Live”选项。

此刻将生成一个全新的模板，我们需对模板的某些部分进行编辑，包括其格式、内容和文本。特别要留意的是，必须将星号*设置正确，并且最终要确认使用的是回车键作为输入。

上图中，文本内容呈现如下，请直接复制其中内容，注意起始处无斜杠符号，且星号需顶格书写。

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

留意到页面右下角的“尚未指定”字样吗？这表明目前该模板尚未明确指定所应使用的语言。

点击操作后，需在弹出的对话框内选择Java选项，以此表明要将此模板应用于所有Java格式的文件类型。

设置

在配置text时，我们曾纳入诸如$date$之类的参数，但当时IDEA对这些参数的真正含义一无所知。接下来，我们将对这些参数进行方法映射，以便IDEA能够准确理解它们的含义。此时，请点击“编辑”按钮：

为每一个参数设置相对应的 ：

设置

需留意的是，在IDEA中，日期和时间功能的调用依赖于其内置函数，只需通过下拉菜单选择即可；然而，对于param这一参数，IDEA的默认实现效果不佳，因此我们不得不自行编写代码来完成这一部分，具体代码如下：

groovyScript(初始化变量result为空字符串，同时定义变量params，该变量通过将字符串${_1}中的特殊字符和空格替换为空，然后按照逗号分割成列表。接着，使用循环从0开始遍历，直到i的值小于某个未指定的上限。< params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())

另外 这个参数我也自己实现了下，代码如下：

groovyScript(, methodReturnType())

我还留意到，我没有勾选“Skip if”属性，该属性的含义是：在生成注释时，若该项被设定，鼠标光标便会自动跳过该部分。我并不需要这一功能，所以特意勾选了该属性。

点击 OK 保存设置，大功告成！

三、检验成果3.1 类注释

类注释只有在新建类时才会自动生成，效果如下：

类注释3.2 方法注释

将演示以下几种情况：

无形参

单个形参

多个形参

无返回值

有返回值

方法注释四、Q & A

为何模板名称必须采用星号(*)？为何“with”一词后必须确保使用的是回车键？

IDEA模板的构建规则是以模板名称与生成键相结合，若生成键设定为Enter，那么通过输入*后紧跟Enter键，即可激活该模板功能。

这也揭示了注释模板首行为何设置为星号(*)的原因，那是因为在先输入了 /* 后，紧接着按下 * 键并回车，便激活了模板，此时首行恰好形成了 /**，这符合相应的格式要求。

（2）注释模板中为什么有一行空的 \*？

由于我习惯于在此处记录操作步骤，因此特意留出了一行空白，供您选择是否删除。

在注释模板中，为何 $time$ 和 $param$ 这两个原本无关联的元素会如此紧密地并排出现？

网上多数param生成函数即便在没有参数时也会自动添加一个空白的@param标签，为此，我对param函数的代码进行了调整，确保在无参数时不再自动创建@param。然而，这一改动需要$param$与其它内容位于同一行，否则将无法正确处理回退格操作。

（4）为什么 参数不使用 ()， 而要自己实现？

在无返回值的情况下，() 会输出 void，这样的操作并无实际意义，因此我对其返回值进行了特别处理，确保只有在存在返回值时才会进行生成操作。

（5）为什么 $$ 不是单独一行？

由于当该函数返回空值时，我们无法解决回退的问题，其缘由与第三点所述相同。

往期热门文章：

1、
6、
8、
9、别总写代码，这130个网站比涨工资都重要
10、程序员养生指北

如有侵权请联系删除！
                             
TAGS：