IDEA设置 方法注释模板 文件注释模板

 

自定义文件头注释

创建文件注释模板有两种方式：首先进入到 File ➡ Settings ➡ Editor ➡ File and Code Templates。

___第一种：

1、右侧窗口点击 Includes下的 File Header文件，在该文件右侧的编辑栏内填入下面的注释代码：

在 Files菜单下所有带 #parse("File Header.java") 的模板文件都会使用该段文件头注释

/**
 * @Author tuohai
 * @Date  ${DATE} ${TIME}
 * @Desc  ${DESCRIPTION}
 */

2、上述注释中的 ${DATE}和 ${TIME}是内置模板，用来获取当前日期和时间；${DESCRIPTION}是我们自定义的模板，在创建文件时可以自定义内容。类似的模板还有很多，在下方的 Description中都有简单的介绍。点击 Apply模板设置成功。详细如下图：

自定义模板的语法：${VALUE} 或者 $VALUE

---

___第二种：

1、右侧窗口 Files下面列表中选择 Class将 #parse("File Header.java")删除，在其位置处放入刚才的文件头注释，点击Apply。详细如下图：

2、测试效果：

---

添加自定义文件模板

在刚才的目录下，可以在 Files列表下自定义文件模板，如：.xml文件、.properties文件。详细如下图：

XML文件的第一行第一列必须要有文档声明：

---

动态注释模板、代码模板

1、打开设置：File ➡ Settings ➡ Editor ➡ Live Templates 直接复制以下代码去创建方法注释：

**
 * @Desc  $DESC$
$PARAMS$     
 * @Return $RETURN$
 */

2、上面的 $DESC$ 也是一种语法，相当于变量。现在并没有效果，接下来要给这些 “变量” 指定脚本函数，详细如下图：

获取方法参数列表代码：

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) ? '\\r\\n' : '')}; return result", methodParameters()))

获取返回值代码：

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())

3、上述步骤完成后，在一个方法上输入 / + 快捷键 （非组合键，先后按下）这里的快捷键是图片中第2步 Abbreviation中预设的，例如我的是 / + d。

效果如下：

动态模板的主要目的是快速生成代码片段，可以灵活运用。