IDEA的类注释模板

类注释模板

首先IDEA的配置路径为：File>Settings>File>Editor>File and Code Templates>Files

可以依次在Class、Interface、Enum、AnnotationType各项的右侧添加注释模板

注释模板为

/**

@className : ${NAME}

@description : [描述说明该类的功能]

@author : [LiuYanQiang]

@version : [v1.0]

@createTime : [${DATE} ${TIME}]

@updateUser : [LiuYanQiang]

@updateTime : [${DATE} ${TIME}]

@updateRemark : [描述说明本次修改内容]

*/

效果展示为

方法注释模板

首先IDEA的配置路径为：File>Settings>File>Editor>Live Templates

1.新建Template Group：MethodTemplate (名称自定义)

2.点击模板组MethodTemplate,然后在最上方By default expand with处选择enter来设置使用注释模板的快捷方式，然后在模板组MethodTemplate下添加Live Template

3.Abbreviation添加为 * ，Description添加为 add Comments for method（此项为添加方法的描述，写不写都行）

4.Template text添加的注释代码：

@version V1.0

Title: N A M E NAMENAME

@author LiuYanQiang

@description 描述说明该方法的功能

@createTime d a t e datedate t i m e timetime

@param p a r a m paramparam

@return r e t u r n returnreturn

注意：如若下面出现No applicable contexts yet. Define的警告则需要设置Everywhere目录下的Java选项，此选项是设置模板的应用场景的（如果以前修改过那出现的就是change）

5.点击Edit variables选项配置参数：

最后在方法名上面用键盘按下CTRL+Shift+/，方法注释就出来了，效果图如下