先看下效果:

红色框里的内容需要自己手动填写。其他是我们设置好的模版

idea 生产javadoc注释 idea生成类注释_IDEA

一:生成类注释

1、File-->settings-->Editor-->File and Code Templates-->Files-->Class

蓝色框里面的内容就是我们需要设置的注释模版,填好模版,单OK,完成。

idea 生产javadoc注释 idea生成类注释_Code_02

注释模版:

/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: Mr.Wu
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

program:自动获取项目名字。

description:对这个类的说明。

每次创建类时会有两次弹框,第一次输入类名字,第二次是让你输入description的内容,也就是对这个类的说明。

author:这个类的创建者,这里可以写上自己的名称。

create:这里自动获取创建类的时候。

假设现在创建一个DateUtil类,创建类时会有两次弹框,如图

idea 生产javadoc注释 idea生成类注释_JAVA_03

效果:

idea 生产javadoc注释 idea生成类注释_IDEA_04

如果我不想在创建类的时候有两次弹框,网上也有很多都是在Includes的File Header里面添加(自行百度),在这里面添加还需要自己去移动下鼠标,然后再去操作键盘,再去写description,,直接在创建类的时候就添加好description不更快吗?

 

二:生成方法注释

打开file->setting->Editor->LiveTemplates点击右边上面那个绿色的+号,选择Template Group双击,然后弹出一个窗口,随便添加一个名字,我这里添加的是AAA然后点击OK 

idea 生产javadoc注释 idea生成类注释_Code_05

蓝色框框里的Tab是我们创建方法后,想插入注释时的快捷键,可根据自己的习惯更改,我未更改。

还是在file->setting->Editor->LiveTemplates这个路径下点击一下刚刚你添加的那个名字(我这是AAA),然后点击右边上面那个绿色的+号,选择LiveTemplate双击

idea 生产javadoc注释 idea生成类注释_JAVA_06

填写下面图上的框 

idea 生产javadoc注释 idea生成类注释_模版_07

操作第4步单击Change会出现下面弹框,勾选Everywhere

idea 生产javadoc注释 idea生成类注释_IDEA_08

操作第5步弹出下面弹框,按图操作(注意,有下拉框,可以选择,免的自己输入时笔误)。

idea 生产javadoc注释 idea生成类注释_Code_09

到此,方法注释模版设置完成,现在实际操作一下。

在刚才创建的DateUtil类下创建一个方法,在方法里输入a(这里的a是前面自己设置的),然后按下Tab键,这时就会生成方法注释

(注意:a需要和方法里输入 ,生成的注释也会在方法里,手动移动到方法外,如果a输在方法外面,是没办法获取到方法参数的,这个可以自己试试)

idea 生产javadoc注释 idea生成类注释_模版_10

idea 生产javadoc注释 idea生成类注释_IDEA_11

下面自己把各参数的含义补全,把注释移动到方法外面,如图:

idea 生产javadoc注释 idea生成类注释_Code_12