idea自动生成类,方法注释,大大提升开发效率

2020-06-10 15:41:57 浏览数 (1)

我们在开发的过程中,新建类,方法,接口等都需要写上注释,频繁的写注释很浪费时间,下面我为大家介绍一种自动生成注释的方式。

操作流程

1. 打开Settings设置

1. 打开Eduitor

1. 选择 File and Code Templates

1. 选择Files

1. 选择 Class

2. 选择 Interface

3. 选择 Enum 等等……包括注解也可以设置。

一:生成类注释

代码语言:javascript复制
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 *
 * @className: ${NAME}
 * @Description: TODO 
 *
 * @version: v1.8.0
 * @author: GONGWENXUE
 * @date: ${DATE} ${TIME}
 *
 */
public class ${NAME} {
}

二:接口注释

代码语言:javascript复制
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 *
 * @className: ${NAME}
 * @Description: TODO 
 *
 * @version: v1.8.0
 * @author: GONGWENXUE
 * @date: ${DATE} ${TIME}
 *
 */
public interface ${NAME} {
}

三:方法注释:

打开 File - Setting 选择 File Templates,点击右上方的 “ ” 进行新建模板,选择1 Live Template 是新建模板,2 Template Group是新建组。可以先新建一个自己的组,将自己建的模板全部放进去,这样方便管理。比如我新建的组是“myGroup”。

Abbreviation是输入模板快捷键代码,Expand with是输入键盘代号后立即选择此模板的快捷键(默认是Tab)。均可以根据自己的习惯选择。

方法注释模板代码:

代码语言:javascript复制
/**
 * @Author GONGWENXUE
 * @Description //TODO $end$
 * @version: v1.8.0
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

另外需要注意的地方是 修改Edit variables,选择适当的时间和参数类别:

0 人点赞