IDEA自定义生成注释与作者版权信息
生成类注释
1、打开Preferences
2、Editor -> File and Code Templates -> Files -> Class
在此添加的话你每次创建类的时候会弹两次框,第二次是让你输入description的内容了
代码如下
/**
* ${description}
*
* @name: ${NAME}
* @author: ${USER}
* @date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/
接口(Interface)、枚举(Enum)、注解(Annotation)的注释同理。
生成效果
IDEA中其他类的查看效果
- 备注:为什么不用下面的格式:因为下面的格式在另一个类无法查看注释。
/**
* @name: ${NAME}
* @description: ${description}
* @author: ${USER}
* @date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/
生成方法注释
打开Preferences
Editor -> Live Templates -> 点击右边加号为自己添加一个Templates Group -> 然后选中自己的Group再次点击加号添加Live Templates
新建模板:命名为c
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为c快捷键用Tab,则生成方式为 /*c+Tab
),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()
* @description: $description$
* @param: $params$
* @return: $returns$
* @author: $user$
* @date: $date$
*/