一、类上的注释模版
-
按照顺序打开
File
→settings
→Editor
→File and Code Templates
→Includes
→File Header
-
详细如图所示
-
输入类注释模板
/** * @ClassName: ${NAME} * @Description: TODO:类文件简单描述 * @Author: ${USER} * @CreateDate: ${DATE} ${TIME} * @UpdateUser: ${USER} * @UpdateDate: ${DATE} ${TIME} * @Version: 0.0.1 */
-
效果如下
二、方法上的注解模版
-
按照顺序打开
File
→Settings
→Editor
→Live Templates
→+
→Template Group
-
创建自己的组名
-
选择自己的组名,点击
+
→Live Template
-
填写
Abbreviation
、Description
、Template text
P.S
-
Abbreviation
: 命名为*
因为IDEA
生成注释的默认方式是:/* 模板名 + 快捷键
(比如若设置模板名为add
快捷键用Tab
,则生成方式为/* add + Tab
) -
Description
: 模板的简单描述 -
Template text
: 注意第一行,只有一个*
而不是/*
, 在设置参数名时必须用${参数名}$
的方式,否则在设置模板的应用场景
的过程中读取不到你设置的参数名
-
-
输入方法注释模板
* * @Description: $description$ * @Author: $author$ * @CreateDate: $date$ $time$ * @UpdateUser: $author$ * @UpdateDate: $date$ $time$ $param$ * @return $returnType$ * @throws $throws$ * @Version: 0.0.1 */
-
设置模板的应用场景
点击模板页面最下方的警告(如果曾经修改过,则显示为
change
而不是define
),来设置将模板应用于那些场景,一般选择EveryWhere
→Java
即可IDEA
还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse
时我们生成注释的习惯是/** + Enter
,这里我们也按照这种习惯来设置IDEA
的方法注释 -
设置参数的获取方式
选择右侧的
Edit variables
按钮,第 6 步和第 7 步顺序不可颠倒,否则第 7 步将获取不到方法groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') return result;if(i==0) result; result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
P.S
选择每个参数对应的获取方法(在下拉选择框中选择即可),获取param
时可以使用groovyScript
脚本的方式,也可以下来选取methodParameters()
方法 -
效果如下
三、XML
-
在步骤二中创建的组名中再创建一个
Live Template
详细内容如下所示 -
选择右侧的
Edit variables
按钮,填入相应的配置值 -
效果如下
-
输入
XML
注释模板<!-- @Description: $description$--> <!-- @Author: $author$--> <!-- @CreateDate: $date$ $time$ -->