IDEA为类和方法设置注解模板过程

1、类方法注解模板

路径在这里：File–>settings–>Editor–>File and Code Templates–>Files

免费影视、动漫、音乐、游戏、小说资源长期稳定更新！ 👉 点此立即查看 👈

先来了解一下类注解里几个关键标签的含义：

• @BelongsProject：用来标注项目名。
• @BelongsPackage：填写当前类的包路径。
• @Author：作者姓名，这个不用多说。
• @CreateTime：记录类的创建时间，模板会自动填充。
• @Description：给这个类写个简要说明，通常先写个“TODO”占位。
• @Version：版本号，新建类一般从1.0开始，直接写死就行。

1.1 模板

接下来，把下面这段模板代码，复制到IDEA刚才那个设置路径里。

/**
*@BelongsProject: ${PROJECT_NAME}
*@BelongsPackage: ${PACKAGE_NAME}
*@Author: zhengyuzhu
*@CreateTime: ${YEAR}-${MONTH}-${DAY}  ${HOUR}:${MINUTE}
*@Description: TODO
*@Version: 1.0
*/

1.2 实际效果

光说不练假把式，新建一个类试试看效果。

/**
 * @BelongsProject: Ja va-Work-Demo
 * @BelongsPackage: A1多线程.B1超时处理.Demo1
 * @Author: zhengyuzhu
 * @CreateTime: 2023-11-14  11:31
 * @Description: TODO
 * @Version: 1.0
 */
public class MyTest {
}

2、方法注解模板(一)

1.1 模板

类模板搞定了，方法模板也不能少。第一种是参数和返回值分开显示的格式，模板如下：

*
 * @description:
 * @author: zhengyuzhu 
 * @date: $date$ $time$
 * @param: $param$
 * @return: $return$
 **/

这个模板最终生成的效果是这样的：

具体怎么设置呢？跟着下面这几步走：

这里有个关键点：操作顺序千万别搞错。否则，函数参数可能读取不到。

1.2 实际效果

设置完成后，在方法上输入“/**”然后回车，就能看到自动生成的注解了。

    /**
     * @description:
     * @author: zhengyuzhu 
     * @date: 2023/11/14 12:21
     * @param: [a, str]
     * @return: void
     **/
    public void Test(int a, String str){
        
    }
    
    /**
     * @description:
     * @author: zhengyuzhu 
     * @date: 2023/11/14 12:22
     * @param: []
     * @return: ja va.util.List
     **/
    public List Test2(){
        ArrayList