idea注释模板设置

idea不同版本虽然略有差别,但整体设置使用方式比较统一,此处以2018.2.4版本为例:

1.类注释模板:

1.1 选择File => Settings => Editor => File and Code Templates => includes => File Hander => 修改注释模板 => Apply => OK

idea注释模板设置idea注释模板设置

/**
 * @Auther: Xulu
 * @ProjectName: ${PROJECT_NAME}
 * @Date: ${DATE} ${HOUR}:${MINUTE}
 * @Description: 
 */

1.2 设置完成后,新建类,会自动创建指定模板的类注释:

idea注释模板设置

2.方法注释模板:

Idea未提供可直接设置方法模板的位置,但可以借用Live Templates模板进行辅助实现,具体步骤如下。

2.1 新建自定义模板组:File => Settings => Editor => Live Templates => 右侧“+” => 选择Template Group新建模板:

idea注释模板设置

2.2 新建自定义模板:Live Template

idea注释模板设置

/**
 *
 * Method Description: 
 *
 * @param: $param$
 * @return: $return$
 * @auther: $user$
 * @date: $date$ $time$
 */

 2.3 点击Define,勾选Java:

idea注释模板设置

2.4 点击Edit variables,填写如图所示:

idea注释模板设置

2.5 点击Apply => OK,将刚才的设置进行应用。

2.6 使用:在需要生成注释的位置“/**”,然后点击Tab键,即可自动生成指定模板格式的注释(建议在对应方法内部进行生成,否则param和return为空,对比如图):

idea注释模板设置