目录
1、设置类注释模板
操作步骤:File-->settings-->Editor-->File and Code Templates-->Files-->Class
我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)
- (1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
- (2)TODO:代办事项的标记,一般生成类或方法都需要添加描述
- (3)${USER}:设置创建类的用户
- (4)${DATE}、${HOUR}、${MINUTE}:创建的日期和时间,这些是IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}
代码:
/**
* @ClassName: ${NAME}
* @Author: ${USER}
* @Date: ${DATE} ${HOUR}:${MINUTE}
* @Description: TODO
*/
效果图:
2、设置方法注释模板
Idea没有可以直接设置方法注释模板的地方,可以借用Live Templates基本实现,步骤如下。
1.选择File–>Settings–>Editor–>Live Templates,先选择右侧绿色加号新建一个自己的模板组,如图命名为myGroup。
2.选中已建好的组,选择右侧绿色加号新建模板,如下图。
3.填好Abbreviation(快捷输入),Description(描述)和模板内容(图中模板如下)
/**
* 功能描述:
* @param: $param$
* @return: $return$
* @auther: $user$
* @date: $date$ $time$
*/
4.点击Define,勾选Java
5.点击Edit variables编辑变量,设置如下,点击Ok–>Apply完成设置。
6.输入“/**”,然后按Enter键即可生成注释,如下图。注意此方式有个缺点,需要在方法内部生成,否则@param为null。