IDEA中类和方法注释模板设置

一、设置类注释模板:

设置成功后,IDEA中在创建类时会自动给添加注释。
1、File–>settings–>Editor–>File and Code Templates–>Files ,选择Class文件,如需设置接口的还也可以选择Interface文件。
(1)ClassName:设置类名,与下面的ClassName一样才能获取到创建的类名;
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述;
(3)Author:设置创建类的用户;
(4)Date:创建的日期和时间;
还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用PROJECT_NAME。
(5)Version:设置版本号,一般新创建的类都是1.0版本,这里写死即可。
IDEA中类和方法注释模板设置_第1张图片
2、效果图展示:
IDEA中类和方法注释模板设置_第2张图片

二、设置方法注释模板:

1、File–>Settings–>Editor–>Live Templates
IDEA中类和方法注释模板设置_第3张图片
(1)新建组:命名为MyGroup
IDEA中类和方法注释模板设置_第4张图片
(2)新建模板:命名为 *
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为 /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters(),获取方法返回值的methodReturnType()。
IDEA中类和方法注释模板设置_第5张图片
(3)设置模板内容:
注意内容第一行,只有一个 *
在设置参数名时必须用 ${参数名} 的方式,否则第五步中读取不到你设置的参数名。

*
 * @Author yangpan
 * @Description //TODO $end$
 * @Param $param$
 * @return $return$
 * @Date $date$ $time$
 */

(4)设置模板的应用场景:
设置将模板应用于哪些场景,一般选择EveryWhere–>Java即可。不设置也可以。(如果曾经修改过,则显示为change而不是define)
IDEA中类和方法注释模板设置_第6张图片
勾选Java。
IDEA中类和方法注释模板设置_第7张图片
(5)设置参数的获取方式:
选择右侧的Edit variables按钮。
IDEA中类和方法注释模板设置_第8张图片
选择每个参数对应的获取方法(在下拉选择框中选择即可)
(6)设置生成注释的快捷键:
这里我选择的是按Tab键。
IDEA中类和方法注释模板设置_第9张图片
(7)效果图:
在Java类中创建一个方法,在方法上输入 /** + 按Tab键。
IDEA中类和方法注释模板设置_第10张图片

你可能感兴趣的:(IDEA中类和方法注释模板设置)