IDEA 创建类时自动生成注释

一、背景

  在开发的过程中，公司都会要求开发针对自己创建的类进行一些描述说明，为了便于程序员在创建类时快速生成注释。

二、如何配置?

  打开File -> Settings -> Editor -> File and Code Templates -> Includes，在File Header中添加如下信息，然后点击OK即可。

/**
 * 功能：
 * <p>
 * ──────────────────────────────────────────
 * version  变更日期       修改人    修改说明
 * ------------------------------------------
 * V1.0.0   ${DATE}       作者名    初版
 * ──────────────────────────────────────────
 *
 * @author 作者名
 */
1
2
3
4
5
6
7
8
9
10
11

3、生成效果

/**
 * 功能： 用电能耗分析、用水能耗分析
 * ──────────────────────────────────────────
 * version  变更日期       修改人    修改说明
 * ------------------------------------------
 * V1.0.0   2024/6/7      作者名     初版
 * ──────────────────────────────────────────
 *
 * @author 作者名
 */
1
2
3
4
5
6
7
8
9
10