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

Java深度编程

发布于 2020-06-10 15:41:57

4.4K0

发布于 2020-06-10 15:41:57

文章被收录于专栏：Java深度编程Java深度编程

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

操作流程

1. 打开Settings设置

1. 打开Eduitor

1. 选择 File and Code Templates

1. 选择Files

1. 选择 Class

2. 选择 Interface

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

一：生成类注释

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 *
 * @className: ${NAME}
 * @Description: TODO 
 *
 * @version: v1.８.0
 * @author: GONGWENXUE
 * @date: ${DATE} ${TIME}
 *
 */
public class ${NAME} {
}

二：接口注释

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 *
 * @className: ${NAME}
 * @Description: TODO 
 *
 * @version: v1.８.0
 * @author: GONGWENXUE
 * @date: ${DATE} ${TIME}
 *
 */
public interface ${NAME} {
}

三：方法注释：

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

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

方法注释模板代码：

/**
 * @Author GONGWENXUE
 * @Description //TODO $end$
 * @version: v1.8.0
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

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

本文参与腾讯云自媒体分享计划，分享自微信公众号。

原始发表：2019-11-19，如有侵权请联系 cloudcommunity@tencent.com 删除

edit

本文分享自 Java深度编程微信公众号，前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体分享计划，欢迎热爱写作的你一起参与！

登录后参与评论

0 条评论

热度